branch: master
commit 4a7079ec1338a71c3ccb9343ce93198509294737
Author: Artur Malabarba <[email protected]>
Commit: Artur Malabarba <[email protected]>
Improve readme
---
Readme.org | 18 +++++++++++-------
example-beacon.gif | Bin 0 -> 2578269 bytes
2 files changed, 11 insertions(+), 7 deletions(-)
diff --git a/Readme.org b/Readme.org
index 621d259..011c8c1 100644
--- a/Readme.org
+++ b/Readme.org
@@ -5,16 +5,20 @@ This is a global minor-mode. Turn it on everywhere with:
(beacon-mode 1)
#+END_SRC
-Whenever point moves a long distance (as defined by
-~beacon-minimum-distance~) a light will shine on top of your cursor
-to make sure you see where it is.
+[[file:example-beacon.gif]]
+
+Whenever the window scrolls or the buffer changes a light will shine
+on top of your cursor so you know where it is.
+
+That’s it.
- To customize the appearance of the beacon, configure
- ~beacon-size~ and ~beacon-brightness~.
+ ~beacon-size~ and ~beacon-color~.
- To customize how long it lasts, configure ~beacon-blink-duration~
and ~beacon-blink-delay~.
-- To customize when it is used at all, configure
- ~beacon-minimum-distance~ and
- ~beacon-blink-when-buffer-changes~.
+- To customize /when/ it is used at all, configure
+ ~beacon-blink-when-window-scrolls~,
+ ~beacon-blink-when-buffer-changes~, and
+ ~beacon-blink-when-point-moves~.
diff --git a/example-beacon.gif b/example-beacon.gif
new file mode 100644
index 0000000..4c01c77
Binary files /dev/null and b/example-beacon.gif differ
