From: Artur Malabarba <bruce.connor.am@gmail.com>
Date: Thu, 15 Oct 2015 22:42:03 +0000 (+0100)
Subject: Extend doc
X-Git-Url: https://code.delx.au/gnu-emacs-elpa/commitdiff_plain/d1f0728ea61891c8afd984861426528df898e918

Extend doc
---

diff --git a/Readme.org b/Readme.org
index cc9cd2996..def0bba34 100644
--- a/Readme.org
+++ b/Readme.org
@@ -7,20 +7,28 @@ This is a global minor-mode.  Turn it on everywhere with:
 
 [[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 or you switch buffer 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-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~.
diff --git a/beacon.el b/beacon.el
index 8e2412008..0b1ae0a1c 100644
--- 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: