branch: master
commit 89b9e9a347a0b89b74a6027003cbc41e39591cdf
Author: Oleh Krehel <[email protected]>
Commit: Oleh Krehel <[email protected]>
README.md: Add sample init
Fixes #112
---
README.md | 12 ++++++++++++
1 files changed, 12 insertions(+), 0 deletions(-)
diff --git a/README.md b/README.md
index 7f06e50..d80cf2b 100644
--- a/README.md
+++ b/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.
