[nongnu] elpa/evil-goggles 87949d4c7e 147/225: Update README

[ELPA Syncer]

branch: elpa/evil-goggles
commit 87949d4c7eb1ffb2644e1d5ddfa7a252fbd77f8f
Author: Evgeni Kolev <evgenysw@gmail.com>
Commit: Evgeni Kolev <evgenysw@gmail.com>

    Update README
---
 README.md       | 19 +++++++++++++++++++
 evil-goggles.el |  3 +--
 2 files changed, 20 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 5bff70cd40..856ede580d 100644
--- a/README.md
+++ b/README.md
@@ -27,6 +27,11 @@ evil-goggles
 
 
![fast-replace](https://cloud.githubusercontent.com/assets/1532071/25314628/889ab1c4-2850-11e7-9cf5-c801b8293583.gif)
 
+## Usage
+
+Enable `(evil-goggles-mode)`, then edit text like you normally would,
+try for example `yy`, `p` `dd` in normal state.
+
 ## Installation
 
 #### with [use-package](https://github.com/jwiegley/use-package) from 
[Melpa](https://melpa.org)
@@ -125,6 +130,20 @@ evil-goggles-undo-redo-change-face
 (setq evil-goggles-duration 0.100) ;; default is 0.200
 ```
 
+- For more fine grained duration configuration, these can be modified:
+
+``` emacs-lisp
+;; this variable affects "blocking" hints, for example when deleting - the 
hint is displayed,
+the deletion is delayed (blocked) until the hint disappers, then the hint is 
removed and the
+deletion executed; it makes sense to have this duration short
+(setq evil-goggles-blocking-duration 0.100) ;; default is nil, i.e. use 
`evil-goggles-duration' which defaults to 0.200
+
+;; this variable affects "async" hints, for example when indenting - the 
indentation
+is performed with the hint visible, i.e. the hint is displayed, the action 
(indent) is
+executed (asynchronous), then the hint is removed, highlighting the result of 
the indentation
+(setq evil-goggles-async-duration 0.900) ;; default is nil, i.e. use 
`evil-goggles-duration' which defaults to 0.200
+```
+
 - To disable the hint on certain actions modify these variable before 
`evil-goggles-mode` is started:
 ```emacs-lisp
 ;; to disable the hint when pasting:
diff --git a/evil-goggles.el b/evil-goggles.el
index 2fb2355be5..a38155bbec 100644
--- a/evil-goggles.el
+++ b/evil-goggles.el
@@ -189,8 +189,7 @@ The overlay is pulsed if variable `evil-goggles-pulse' is 
t."
 
 If hint is visible, check it's ok to display it from BEG to END.  If
 it's not, do BODY1, else BODY2."
-  ;; TODO indent like `if'
-  (declare (indent 3) (debug t))
+  (declare (indent 3) (debug t)) ;; TODO indent like `if'
   `(if (and (not evil-goggles--on) (evil-goggles--show-p ,beg ,end))
        (let ((evil-goggles--on t))
          ,@body2)