From 8399143901f181fb57e145e167405199cedf174e Mon Sep 17 00:00:00 2001
From: Henrik Lissner <henrik@lissner.net>
Date: Tue, 23 Apr 2019 14:12:26 -0400
Subject: [PATCH] ui/nav-flash: update README

---
 modules/ui/nav-flash/README.org | 50 ++++++++++++++++++++-------------
 1 file changed, 31 insertions(+), 19 deletions(-)

diff --git a/modules/ui/nav-flash/README.org b/modules/ui/nav-flash/README.org
index 7fd4772ce..105c1d183 100644
--- a/modules/ui/nav-flash/README.org
+++ b/modules/ui/nav-flash/README.org
@@ -1,25 +1,37 @@
-#+TITLE: :ui nav-flash
-
-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.
-
-#+begin_quote
-Tremendously helpful on a 30" 2560x1600 display.
-#+end_quote
+#+TITLE:   ui/nav-flash
+#+DATE:    June 4, 2017
+#+SINCE:   v2.0
+#+STARTUP: inlineimages
 
 * Table of Contents :TOC:
-- [[#install][Install]]
-- [[#configure][Configure]]
+- [[#description][Description]]
+  - [[#plugins][Plugins]]
+- [[#prerequisites][Prerequisites]]
+- [[#configuration][Configuration]]
 
-* Install
-This module has no other dependencies.
+* Description
+This module flashes the line around the cursor after any significant motion, to
+make it easy to follow after big operations.
 
-* Configure
-By default, ~nav-flash~ will be triggered whenever ~recenter~ is called. =:feature jump= attaches ~recenter~ to various hooks:
+#+begin_quote
+Tremendously helpful on large, 1600p+ or 4K displays.
+#+end_quote
 
-#+BEGIN_SRC emacs-lisp
-(add-hook!
-  '(imenu-after-jump-hook evil-jumps-post-jump-hook
-    counsel-grep-post-action-hook dumb-jump-after-jump-hook)
-  #'recenter)
-#+END_SRC
+** Plugins
++ [[https://github.com/rolandwalker/nav-flash][nav-flash]]
 
+* 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