From 0b7041e1a22603d5f92463e8c53d05108c53efa3 Mon Sep 17 00:00:00 2001 From: Artur Malabarba Date: Thu, 15 Oct 2015 14:43:36 +0100 Subject: [PATCH] More documentation --- Readme.org | 2 ++ beacon.el | 26 ++++++++++++++++++++++++-- 2 files changed, 26 insertions(+), 2 deletions(-) diff --git a/Readme.org b/Readme.org index 011c8c1c3..cc9cd2996 100644 --- a/Readme.org +++ b/Readme.org @@ -12,6 +12,8 @@ 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~. diff --git a/beacon.el b/beacon.el index 149f6fbc7..8abafe293 100644 --- a/beacon.el +++ b/beacon.el @@ -23,8 +23,30 @@ ;;; Commentary: -;; This is a global minor-mode. Turn it on everywhere with -;; (beacon-mode 1) +;; This is a global minor-mode. Turn it on everywhere with: +;; ┌──── +;; │ (beacon-mode 1) +;; └──── +;; +;; 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. +;; +;; +;; 1 Customizations +;; ════════════════ +;; +;; • To customize the appearance of the beacon, configure `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-blink-when-window-scrolls', +;; `beacon-blink-when-buffer-changes', and +;; `beacon-blink-when-point-moves'. ;;; Code: -- 2.39.2