branch: elpa/evil-anzu
commit 0bbb681a4d0b06ea88e98e8cc63f0498239764d8
Author: Syohei YOSHIDA <[email protected]>
Commit: Syohei YOSHIDA <[email protected]>
Update README
- Add badges
- Add Installation section
---
README.md | 12 ++++++++++--
1 file changed, 10 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md
index d3bdc32e3e..e4e2a407eb 100644
--- a/README.md
+++ b/README.md
@@ -1,16 +1,24 @@
-# evil-anzu
+# evil-anzu [![melpa badge][melpa-badge]][melpa-link] [![melpa stable
badge][melpa-stable-badge]][melpa-stable-link]
[anzu](https://github.com/syohex/emacs-anzu) for
[evil-mode](https://gitorious.org/evil)
-evil-anzu is currently under development.
## Screencast

+## Installation
+
+You can install evil-anzu.el from [MELPA](http://melpa.org) with package.el.
+
## Configuration
```lisp
(define-key evil-motion-state-map "n" 'evil-anzu-search-next)
(define-key evil-motion-state-map "N" 'evil-anzu-search-previous)
```
+
+[melpa-link]: http://melpa.org/#/evil-anzu
+[melpa-stable-link]: http://melpa.org/#/evil-anzu
+[melpa-badge]: http://melpa.org/packages/evil-anzu-badge.svg
+[melpa-stable-badge]: http://stable.melpa.org/packages/evil-anzu-badge.svg