]> code.delx.au - gnu-emacs-elpa/commitdiff
README.md: Add a secion on Ivy
authorOleh Krehel <ohwoeowho@gmail.com>
Thu, 21 May 2015 09:45:17 +0000 (11:45 +0200)
committerOleh Krehel <ohwoeowho@gmail.com>
Sat, 23 May 2015 11:18:58 +0000 (13:18 +0200)
README.md

index d80cf2bfa6411aa10646f8b866babe7fd61e85f8..d70eeaf42a86db304896c0c1b80e80d3d00a462f 100644 (file)
--- a/README.md
+++ b/README.md
@@ -15,16 +15,28 @@ The package uses the `ivy` back end for the overview, see also
 
 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 minimal configuration:
+Here is some typical configuration:
 
 ```elisp
 (ivy-mode 1)
 (setq ivy-use-virtual-buffers t)
 (global-set-key "\C-s" 'swiper)
 (global-set-key "\C-r" 'swiper)
+(global-set-key (kbd "C-c C-r") 'ivy-resume)
+(global-set-key [f6] 'ivy-resume)
 ```
 
 ## Issues