Merge commit 'bc335af4d94d80d3605b66ed51a15d2476ad2179' from swiper

[gnu-emacs-elpa] / packages / swiper / README.md

diff --git a/packages/swiper/README.md b/packages/swiper/README.md
index 7f06e504c7e5744955f237514de20e2d32a9e810..d80cf2bfa6411aa10646f8b866babe7fd61e85f8 100644 (file)
--- a/packages/swiper/README.md
+++ b/packages/swiper/README.md
@@ -15,6 +15,18 @@ 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).
 
+## Installation
+
+You can install the package from MELPA / GNU ELPA.
+Here is some minimal configuration:
+
+```elisp
+(ivy-mode 1)
+(setq ivy-use-virtual-buffers t)
+(global-set-key "\C-s" 'swiper)
+(global-set-key "\C-r" 'swiper)
+```
+
 ## 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.