branch: elpa/evil-args
commit c19bc8d7f77bf76634a341eaf507e6e65c2c0247
Author: wcsmith <wconnorsm...@gmail.com>
Commit: wcsmith <wconnorsm...@gmail.com>
Updated README.
---
README.md | 86 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++-
1 file changed, 85 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md
index 1187157ba7..cbb7ff5bd8 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,90 @@
# evil-args
+Motions and text objects for delimited arguments in
[Evil](https://gitorious.org/evil/), the extensible vi layer for Emacs.
## Setup
Get it with:
- git clone https://github.com/wcsmith/evil-args.git
\ No newline at end of file
+ git clone https://github.com/wcsmith/evil-args.git
+
+Add the following to your `.emacs`:
+
+ (add-to-list 'load-path "path/to/evil-args")
+ (require 'evil-args)
+
+Optionally, add the following keybindings with keys of your choice:
+
+ (define-key evil-normal-state-map "L" 'evil-forward-arg)
+ (define-key evil-normal-state-map "H" 'evil-backward-arg)
+
+ (define-key evil-inner-text-objects-map "a" 'evil-inner-arg)
+ (define-key evil-outer-text-objects-map "a" 'evil-outer-arg)
+
+ (define-key evil-normal-state-map "K" 'evil-jump-out-args)
+
+##Functionality
+###`evil-forward-arg`/`evil-backward-arg`
+Move the curser to the next/previous argument.
+
+For example, successive presses of `evil-forward-arg` yield:
+
+ function(ar|g1, arg2, arg3)
+ function(arg1, |arg2, arg3)
+ function(arg1, arg2, |arg3)
+ function(arg1, arg2, arg3|)
+
+Successive presses of `evil-backward-arg` yield:
+
+ function(arg1, arg2, ar|g3)
+ function(arg1, arg2, |arg3)
+ function(arg1, |arg2, arg3)
+ function(|arg1, arg2, arg3)
+
+###`evil-inner-arg`/`evil-outer-arg`
+
+Select an inner/outer argument text object.
+
+For example, `cia` transforms:
+
+ function(ar|g1, arg2, arg3)
+ function(|, arg2, arg3)
+
+or
+
+ function(arg1, ar|g2, arg3)
+ function(arg1, |, arg3)
+
+`daa` transforms:
+
+ function(ar|g1, arg2, arg3)
+ function(|arg2, arg3)
+
+or
+
+ function(arg1, ar|g2, arg3)
+ function(arg1, |arg3)
+
+###`evil-jump-out-args`
+
+Moves to the beginning of the first object outside of the current argument
context.
+
+For example, pressing `evil-jump-out-args` yields:
+
+ function(arg1, arg2, ar|g3)
+ |function(arg1, arg2, arg3)
+
+Successive presses of `evil-jump-out-args` yield:
+
+ if (x == y) {
+ statement1;
+ state|ment2;
+ }
+
+ if (|x == y) {
+ statement1;
+ statement2;
+ }
+
+ |if (x == y) {
+ statement1;
+ statement2;
+ }
\ No newline at end of file
