doc/ivy.texi: Re-export using adjusted texinfo exporter

[gnu-emacs-elpa] / README.md

diff --git a/README.md b/README.md
index eba47b5afd0cc7b63391c073c6cc96a667913875..0d80f8dfd1c9d96958235bbd87138adb49427901 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,28 +1,51 @@
+[![Build Status](https://travis-ci.org/abo-abo/swiper.svg?branch=master)](https://travis-ci.org/abo-abo/swiper)
+
 ## Swiper
 
 Package for GNU Emacs that gives you an overview as you search for a regex
 
 ![swiper.png](http://oremacs.com/download/swiper.png)
 
-The package allows for two different back ends for the overview: `helm` and `ivy`.  You can set the
-one you want by customizing `swiper-completion-method`.
-
-## Screenshots of the `ivy` back end
+The package uses the `ivy` back end for the overview, see also
+[swiper-helm](https://github.com/abo-abo/swiper-helm).
 
-### One
+## Screenshots
 
 ![ivy-swiper-1.png](http://oremacs.com/download/ivy-swiper-1.png)
 
-## Screenshots of the `helm` back end
-
-### One
-
-![swiper-1.png](http://oremacs.com/download/swiper-1.png)
-
-### Two
-
-![swiper-2.png](http://oremacs.com/download/swiper-2.png)
-
-### Three
-
-![swiper-3.png](http://oremacs.com/download/swiper-3.png)
+There's also a ten minute [video demo](https://www.youtube.com/watch?v=VvnJQpTFVDc).
+
+## Ivy
+
+Ivy is a generic completion method for Emacs, similar to
+`icomplete-mode`. It aims to be more efficient, more simple, and more
+pleasant to use than the alternatives. It's also highly customizable
+and very small.
+
+To try it, just call <kbd>M-x</kbd> `ivy-mode`, and all generic
+completion, including file and buffer names, will be done with Ivy.
+
+## Installation
+
+You can install the package from MELPA / GNU ELPA.
+Here is some typical configuration:
+
+```elisp
+(ivy-mode 1)
+(setq ivy-use-virtual-buffers t)
+(global-set-key "\C-s" 'swiper)
+(global-set-key (kbd "C-c C-r") 'ivy-resume)
+(global-set-key (kbd "<f6>") 'ivy-resume)
+(global-set-key (kbd "M-x") 'counsel-M-x)
+(global-set-key (kbd "C-x C-f") 'counsel-find-file)
+(global-set-key (kbd "<f1> f") 'counsel-describe-function)
+(global-set-key (kbd "<f1> v") 'counsel-describe-variable)
+(global-set-key (kbd "<f1> l") 'counsel-load-library)
+(global-set-key (kbd "<f2> i") 'counsel-info-lookup-symbol)
+(global-set-key (kbd "<f2> u") 'counsel-unicode-char)
+(global-set-key (kbd "C-c g") 'counsel-git)
+(global-set-key (kbd "C-c j") 'counsel-git-grep)
+(global-set-key (kbd "C-c k") 'counsel-ag)
+(global-set-key (kbd "C-x l") 'counsel-locate)
+(global-set-key (kbd "C-S-o") 'counsel-rhythmbox)
+```