X-Git-Url: https://code.delx.au/gnu-emacs-elpa/blobdiff_plain/e2452a3e77ef6ea6b193292d2c0bbbe93dd4b078..d374afea36df19b5d6b654adc6018b25d6c1d8f2:/README.md

diff --git a/README.md b/README.md
index 7f06e504c..d70eeaf42 100644
--- a/README.md
+++ b/README.md
@@ -15,6 +15,30 @@ 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 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
 
 Recently, the `ivy` package that provided `ivy.el` was removed from MELPA.  Now, the `swiper` package provides `ivy.el`. You should remove the outdated `ivy` package from your system.