[nongnu] elpa/scroll-on-jump eb77ab1920 02/31: readme: add a more complete example

[ELPA Syncer]

branch: elpa/scroll-on-jump
commit eb77ab1920479bf04987e2808e1b782deddd3977
Author: Campbell Barton <ideasman42@gmail.com>
Commit: Campbell Barton <ideasman42@gmail.com>

    readme: add a more complete example
---
 readme.rst | 27 +++++++++++++++++++++++++++
 1 file changed, 27 insertions(+)

diff --git a/readme.rst b/readme.rst
index 037c209b41..bc177ad946 100644
--- a/readme.rst
+++ b/readme.rst
@@ -109,6 +109,33 @@ After:
    (global-set-key (kbd "<f12>")
      (lambda () (interactive) (scroll-on-jump (my-function))))
 
+
+Complete Example
+----------------
+
+Here is a more complete example for evil-mode users.
+
+.. code-block:: elisp
+
+   (with-eval-after-load 'evil
+     (scroll-on-jump-advice-add evil-undo)
+     (scroll-on-jump-advice-add evil-redo)
+     (scroll-on-jump-advice-add evil-jump-item)
+     (scroll-on-jump-advice-add evil-jump-forward)
+     (scroll-on-jump-advice-add evil-jump-backward)
+     (scroll-on-jump-advice-add evil-ex-search-next)
+     (scroll-on-jump-advice-add evil-ex-search-previous)
+     (scroll-on-jump-advice-add evil-forward-paragraph)
+     (scroll-on-jump-advice-add evil-backward-paragraph))
+
+   (with-eval-after-load 'goto-chg
+     (scroll-on-jump-advice-add goto-last-change)
+     (scroll-on-jump-advice-add goto-last-change-reverse))
+
+   (global-set-key (kbd "<C-M-next>") (scroll-on-jump-interactive 
'diff-hl-next-hunk))
+   (global-set-key (kbd "<C-M-prior>") (scroll-on-jump-interactive 
'diff-hl-previous-hunk)))
+
+
 Customization
 =============