ui/nav-flash: update README

modules/ui/nav-flash/README.org

@@ -1,25 +1,37 @@
-#+TITLE: :ui nav-flash
+#+TITLE:   ui/nav-flash
-
+#+DATE:    June 4, 2017
-This module uses ~nav-flash~ to flash the line around the cursor after any motion command that might reasonably send the cursor somewhere the eyes can't follow.
+#+SINCE:   v2.0
-
+#+STARTUP: inlineimages
-#+begin_quote
-Tremendously helpful on a 30" 2560x1600 display.
-#+end_quote
 
 * Table of Contents :TOC:
-- [[#install][Install]]
+- [[#description][Description]]
-- [[#configure][Configure]]
+  - [[#plugins][Plugins]]
+- [[#prerequisites][Prerequisites]]
+- [[#configuration][Configuration]]
 
-* Install
+* Description
-This module has no other dependencies.
+This module flashes the line around the cursor after any significant motion, to
+make it easy to follow after big operations.
 
-* Configure
+#+begin_quote
-By default, ~nav-flash~ will be triggered whenever ~recenter~ is called. =:feature jump= attaches ~recenter~ to various hooks:
+Tremendously helpful on large, 1600p+ or 4K displays.
+#+end_quote
 
-#+BEGIN_SRC emacs-lisp
+** Plugins
-(add-hook!
++ [[https://github.com/rolandwalker/nav-flash][nav-flash]]
-  '(imenu-after-jump-hook evil-jumps-post-jump-hook
-    counsel-grep-post-action-hook dumb-jump-after-jump-hook)
-  #'recenter)
-#+END_SRC
 
+* Prerequisites
+This module has no dependencies.
+
+* Configuration
+By default, ~nav-flash~ will be triggered whenever ~recenter~ is called or an
+entry is added to the jump-list (maanaged by better-jumper).
+
+~recenter~ is called after many hooks and commands, such as:
+
++ better-jumper-post-jump-hook
++ rtags-after-find-file-hook
++ org-follow-link-hook
++ imenu-after-jump-hook
++ counsel-grep-post-action-hook
++ dumb-jump-after-jump-hook