aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPaul W. Rankin <pwr@bydasein.com>2020-03-11 15:47:36 +1000
committerWilliam Rankin <code@william.bydasein.com>2020-03-11 15:47:36 +1000
commit967c83bfa2b1c3b25c3b98d1688312e2ea98c589 (patch)
treef24b4768c34bd7c532bc95623b0e49981b032827
parentd7c132127cd42be63cce2a36490ce3738a34c4c4 (diff)
downloadside-notes-0.3.1.zip
Update README/Commentaryv0.3.1
-rw-r--r--README.md17
-rw-r--r--side-notes.el16
2 files changed, 25 insertions, 8 deletions
diff --git a/README.md b/README.md
index 4c14a9d..ce0f61d 100644
--- a/README.md
+++ b/README.md
@@ -3,13 +3,22 @@
Quickly display your quick side notes in quick side window.
Side notes live in a file in the current directory or any parent
-directory thereof. The filename to look for is defined by custom option
-side-notes-file, which defaults to "notes.txt".
+directory thereof and is displayed in a side window with
+`side-notes-toggle-notes`. The filename to look for is defined by user
+option `side-notes-file`, which defaults to "notes.txt".
-For more info, see (info "(elisp) Side Windows")
+To really mix things up, there's the optional
+`side-notes-secondary-file`, which, when non-nil, will display a
+separate notes file in a lower side window when the command
+`side-notes-toggle-notes` is prefixed with an argument (`C-u`).
+
+For more info, see `(info "(elisp) Side Windows")`
## Installation ##
-Add something like the following to your init file:
+Install from [MELPA stable][] then add something like the following to
+your init file:
(define-key (current-global-map) (kbd "M-s n") #'side-notes-toggle-notes)
+
+[melpa stable]: https://stable.melpa.org/#/side-notes
diff --git a/side-notes.el b/side-notes.el
index 4954561..5e417b1 100644
--- a/side-notes.el
+++ b/side-notes.el
@@ -30,17 +30,25 @@
;; Quickly display your quick side notes in quick side window.
;; Side notes live in a file in the current directory or any parent
-;; directory thereof. The filename to look for is defined by custom option
-;; side-notes-file, which defaults to "notes.txt".
+;; directory thereof and is displayed in a side window with
+;; side-notes-toggle-notes. The filename to look for is defined by user
+;; option side-notes-file, which defaults to "notes.txt".
+
+;; To really mix things up, there's the optional
+;; side-notes-secondary-file, which, when non-nil, will display a
+;; separate notes file in a lower side window when the command
+;; side-notes-toggle-notes is prefixed with an argument (C-u).
;; For more info, see (info "(elisp) Side Windows")
;; ## Installation ##
-;; Add something like the following to your init file:
+;; Install from [MELPA stable] then add something like the following to
+;; your init file:
-;; (define-key (current-global-map) (kbd "M-s n") #'side-notes-toggle-notes)
+;; (define-key (current-global-map) (kbd "M-s n") #'side-notes-toggle-notes)
+;; [melpa stable]: https://stable.melpa.org/#/side-notes
;;; Code: