Extend doc

[gnu-emacs-elpa] / beacon.el

diff --git a/beacon.el b/beacon.el
index 8e24120081cc8335f0a49ace3fd779483d224ea8..0b1ae0a1c023774603fe270738ce65671660e2d5 100644 (file)
--- a/beacon.el
+++ b/beacon.el
@@ -1,4 +1,4 @@
-;;; beacon.el --- Highlight the cursor whenever it moves long distances  -*- lexical-binding: t; -*-
+;;; beacon.el --- Highlight the cursor whenever the window scrolls  -*- lexical-binding: t; -*-
 
 ;; Copyright (C) 2015 Free Software Foundation, Inc.
 
@@ -28,7 +28,7 @@
 ;; │ (beacon-mode 1)
 ;; └────
 ;;
-;; Whenever the window scrolls or the buffer changes a light will shine on
+;; Whenever the window scrolls or you switch buffer a light will shine on
 ;; top of your cursor so you know where it is.
 ;;
 ;; That’s it.
@@ -37,16 +37,24 @@
 ;; 1 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-point-moves'.
+;;
+;;   • To prevent the beacon from blinking only on some major-modes,
+;;     configure `beacon-dont-blink-major-modes'. For specific buffers, you
+;;     can do `(setq-local beacon-mode nil)'. For even more refined
+;;     control, configure `beacon-dont-blink-predicates'
+;;
+;;   • Beacon can also push the mark for you whenever point moves a long
+;;     distance. For this, configure `beacon-push-mark'.
 
 ;;; Code: