[[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.
+Whenever the window scrolls a light will shine on top of your cursor
+so you know where it is.
That’s it.
** Customizations
-- To customize the appearance of the beacon, configure
- ~beacon-size~ and ~beacon-color~.
+- The appearance of the beacon is configured by ~beacon-size~ and
+ ~beacon-color~.
-- To customize how long it lasts, configure ~beacon-blink-duration~
- and ~beacon-blink-delay~.
+- The duration is configured by ~beacon-blink-duration~ and
+ ~beacon-blink-delay~.
-- To customize /when/ it is used at all, configure
+- To customize /when/ the beacon should blink at all, configure
~beacon-blink-when-window-scrolls~,
- ~beacon-blink-when-buffer-changes~, and
+ ~beacon-blink-when-window-changes~, and
~beacon-blink-when-point-moves~.
+
+- To prevent the beacon from blinking only on specific situations
+ configure ~beacon-dont-blink-major-modes~,
+ ~beacon-dont-blink-predicates~, or ~beacon-dont-blink-commands~. You
+ can also disable it only in specific buffers by doing
+ ~(setq-local beacon-mode nil)~.
+
+- Beacon can also push the mark for you whenever point moves a long
+ distance. For this, configure ~beacon-push-mark~.
+
+** Contributors
+
+- [[https://github.com/tsdh][Tassilo Horn]]
+
+If you’d like to help too, just open a PR.