[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] master 9e5e52b 6/8: README.md: Add a secion on Ivy
From: |
Oleh Krehel |
Subject: |
[elpa] master 9e5e52b 6/8: README.md: Add a secion on Ivy |
Date: |
Sat, 23 May 2015 11:31:04 +0000 |
branch: master
commit 9e5e52bedd7a00aa74a23fde92fc713cc7275714
Author: Oleh Krehel <address@hidden>
Commit: Oleh Krehel <address@hidden>
README.md: Add a secion on Ivy
---
README.md | 14 +++++++++++++-
1 files changed, 13 insertions(+), 1 deletions(-)
diff --git a/README.md b/README.md
index d80cf2b..d70eeaf 100644
--- 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
- [elpa] master updated (08e02f3 -> 740b7e6), Oleh Krehel, 2015/05/23
- [elpa] master 4b505da 2/8: ivy.el (ivy-completing-read): Check for a cons initial-input, Oleh Krehel, 2015/05/23
- [elpa] master c19c5ed 3/8: counsel.el (counsel-git): Switch to action-style call, Oleh Krehel, 2015/05/23
- [elpa] master 57ca591 1/8: * swiper/ivy.el: Clean up regexps and pseudo-closures, Oleh Krehel, 2015/05/23
- [elpa] master 69491ad 4/8: Fixup "C-u C-j" for `ivy-switch-buffer', Oleh Krehel, 2015/05/23
- [elpa] master 9e5e52b 6/8: README.md: Add a secion on Ivy,
Oleh Krehel <=
- [elpa] master 3c098bd 5/8: The :action parameter to ivy-read should take one arg, Oleh Krehel, 2015/05/23
- [elpa] master e084b5d 7/8: swiper.el: Bump version, Oleh Krehel, 2015/05/23
- [elpa] master 740b7e6 8/8: Merge commit 'e084b5d9feab3dd1246e51ce1fddde3db6024f7d' from swiper, Oleh Krehel, 2015/05/23