[nongnu] elpa/evil-numbers e40b606d92 025/145: Add readme.

[ELPA Syncer]

branch: elpa/evil-numbers
commit e40b606d92d87cdae5a4eeee8ba0cf49fe8556c2
Author: Michael Markert <markert.michael@googlemail.com>
Commit: Michael Markert <markert.michael@googlemail.com>

    Add readme.
    
    Signed-off-by: Michael Markert <markert.michael@googlemail.com>
---
 README.org      | 31 +++++++++++++++++++++++++++++++
 evil-numbers.el |  2 +-
 2 files changed, 32 insertions(+), 1 deletion(-)

diff --git a/README.org b/README.org
new file mode 100644
index 0000000000..2e073a4e50
--- /dev/null
+++ b/README.org
@@ -0,0 +1,31 @@
+* Evil Numbers
+  - Increment / Decrement binary, octal, decimal and hex literals
+
+  - works like C-a/C-x in vim, i.e. searches for number up to eol and then
+    increments or decrements and keep zero padding up (unlike in vim)
+
+** Detected Literals
+    - binary, e.g. =0b0101=, =0B0101=
+    - octal, e.g. =0o755=, =0O700=
+    - hexadecimal, e.g. =0xDEADBEEF=, =0XCAFE=
+
+** Install
+   Put in =load-path=, =(require 'evil-numbers)= and bind, for example:
+
+   #+BEGIN_SRC emacs-lisp
+     (global-set-key (kbd "C-c +") 'evil-numbers/inc-at-pt)
+     (global-set-key (kbd "C-c -") 'evil-numbers/dec-at-pt)
+   #+END_SRC
+
+   or only in evil's normal state:
+
+   #+BEGIN_SRC emacs-lisp
+    (define-key evil-normal-state-map (kbd "C-c +") 'evil-numbers/inc-at-pt)
+    (define-key evil-normal-state-map (kbd "C-c -") 'evil-numbers/dec-at-pt)
+   #+END_SRC
+
+** Usage
+   Position cursor on literal and play with your numbers!
+
+** Known Bugs
+   See http://github.com/cofi/evil-numbers/issues
diff --git a/evil-numbers.el b/evil-numbers.el
index fabf853184..d92843c288 100644
--- a/evil-numbers.el
+++ b/evil-numbers.el
@@ -5,7 +5,7 @@
 ;; URL: http://github.com/cofi/evil-numbers
 ;; Git-Repository: git://github.com/cofi/evil-numbers.git
 ;; Created: 2011-09-02
-;; Version: 0.2
+;; Version: 0.3
 ;; Keywords: numbers increment decrement octal hex binary
 
 ;; This file is not part of GNU Emacs.