-#+TITLE: Spotlight --- Never lose your cursor again
+#+TITLE: Beacon --- Never lose your cursor again
This is a global minor-mode. Turn it on everywhere with:
#+BEGIN_SRC emacs-lisp
-(spotlight-mode 1)
+(beacon-mode 1)
#+END_SRC
-Whenever point moves a long distance (as defined by
-~spotlight-minimum-distance~) a light will shine on top of your cursor
-to make sure you see where it is.
+[[file:example-beacon.gif]]
-- To customize the appearance of the spotlight, configure
- ~spotlight-size~ and ~spotlight-brightness~.
+Whenever the window scrolls a light will shine on top of your cursor
+so you know where it is.
-- To customize how long it lasts, configure ~spotlight-blink-duration~
- and ~spotlight-blink-delay~.
+That’s it.
-- To customize when it is used at all, configure
- ~spotlight-minimum-distance~ and
- ~spotlight-blink-when-buffer-changes~.
+** Customizations
+
+- The appearance of the beacon is configured by ~beacon-size~ and
+ ~beacon-color~.
+
+- The duration is configured by ~beacon-blink-duration~ and
+ ~beacon-blink-delay~.
+
+- To customize /when/ the beacon should blink at all, configure
+ ~beacon-blink-when-window-scrolls~,
+ ~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.