branch: elpa/evil-exchange
commit ee17ab47fee931e7fb19358e00252e9c75bff4df
Author: Dewdrops <[email protected]>
Commit: Dewdrops <[email protected]>
improve doc
---
README.md | 11 ++++++-----
evil-exchange.el | 2 +-
2 files changed, 7 insertions(+), 6 deletions(-)
diff --git a/README.md b/README.md
index 55b68f741e..bbe3e51c52 100644
--- a/README.md
+++ b/README.md
@@ -1,19 +1,19 @@
+English is not my first language, so feel free to correct me of any mistake.
+
evil-exchange
============
-English is not my first language, so feel free to correct me of any mistake.
-
Easy text exchange operator for Evil. This is the port of
[vim-exchange](https://github.com/tommcdo/vim-exchange) by Tom McDonald.
Default bindings
--------
-`gx`
+`gx` (evil-exchange)
On the first use, define the first {motion} to exchange. On the second use,
define the second {motion} and perform the exchange.
-`gX`
+`gX` (evil-exchange-cancel)
Clear any {motion} pending for exchange.
@@ -29,7 +29,7 @@ Installation
```lisp
(require 'evil-exchange)
-;; if you want to change default key bindings
+;; change default key bindings (if you want) HERE
;; (setq evil-exchange-key (kbd "zx"))
(evil-exchange-install)
```
@@ -38,3 +38,4 @@ Customization
-------
You can change the default bindings by customizing `evil-exchange-key` and/or
`evil-exchange-cancel-key` BEFORE `evil-exchange-install` is called.
+
diff --git a/evil-exchange.el b/evil-exchange.el
index 1cbdfe550d..ce6d9d05c8 100644
--- a/evil-exchange.el
+++ b/evil-exchange.el
@@ -33,7 +33,7 @@
;; put evil-exchange.el into somewhere in your load-path and add these
;; lines to your .emacs:
;; (require 'evil-exchange)
-;; ;; if you want to change default key bindings, bind it to as you like HERE
+;; ;; change default key bindings (if you want) HERE
;; ;; (setq evil-exchange-key (kbd "zx"))
;; (evil-exchange-install)
