aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPaul W. Rankin <pwr@bydasein.com>2020-09-27 00:04:45 +1000
committerWilliam Rankin <william@bydasein.com>2020-09-27 00:04:45 +1000
commite92c17055c0fc4e7704a60556825b3113c14a497 (patch)
treeb0e34c79592505ae5cb113cb66f9fcd5dbc6d2b8
parent7681fe60f462cc8c3ece95546a2d42f23e2c02a2 (diff)
downloadside-notes-e92c17055c0fc4e7704a60556825b3113c14a497.zip
Update README/Commentary
-rw-r--r--README.md43
-rw-r--r--side-notes.el40
2 files changed, 45 insertions, 38 deletions
diff --git a/README.md b/README.md
index c5f3ccc..2f5aa12 100644
--- a/README.md
+++ b/README.md
@@ -1,12 +1,16 @@
-# Side Notes #
+Side Notes
+==========
+
+[![MELPA Stable](https://stable.melpa.org/packages/side-notes-badge.svg)][1]
+[![MELPA](https://melpa.org/packages/side-notes-badge.svg)][2]
Quickly display your quick side notes in quick side window.
-Side notes live in a plain text file, called `notes.txt` by default,
-in the current directory or any higher directory in the current
-hierarchy. i.e. When locating notes, we first look for a `notes.txt`
-file in the current directory, then one directory up, then two
-directories up, and so forth.
+Side notes live in a plain text file, called `notes.txt` by default, in
+the current directory or any higher directory in the current hierarchy.
+i.e. When locating notes, we first look for a `notes.txt` file in the
+current directory, then one directory up, then two directories up, and
+so forth.
Side notes are displayed in a side window with the command
`side-notes-toggle-notes`.
@@ -18,28 +22,29 @@ To really mix things up, there's the user option
display a separate notes file in a lower side window when the command
`side-notes-toggle-notes` is prefixed with an argument (`C-u`).
-By default, having a notes file in any parent directory will locate
-that file rather than visit a non-existing file in the current
-directory, but you can override this by prefixing
-`side-notes-toggle-notes` with...
+By default, having a notes file in any parent directory will locate that
+file rather than visit a non-existing file in the current directory, but
+you can override this by prefixing `side-notes-toggle-notes` with...
-- `C-u C-u` to force visiting `side-notes-file` within the current
- directory.
-- `C-u C-u C-u` to force visiting `side-notes-secondary-file` within
- the current directory.
+- `C-u C-u` to force visiting `side-notes-file` within the current
+ directory.
+- `C-u C-u C-u` to force visiting `side-notes-secondary-file` within
+ the current directory.
Of course, you can use Markdown or Org Mode formatting by changing the
-file extensions of `side-notes-file` and/or
-`side-notes-secondary-file`.
+file extensions of `side-notes-file` and/or `side-notes-secondary-file`.
For more information on how to change the way the side window is
displayed, see `(info "(elisp) Side Windows")`
-## Installation ##
-Install from [MELPA stable][] then add something like the following to
+Installation
+------------
+
+Install from [MELPA stable][1] 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
+[1]: https://stable.melpa.org/#/side-notes
+[2]: https://melpa.org/#/side-notes
diff --git a/side-notes.el b/side-notes.el
index 149ded5..7551fc5 100644
--- a/side-notes.el
+++ b/side-notes.el
@@ -25,15 +25,16 @@
;;; Commentary:
-;; # Side Notes #
+;; Side Notes
+;; ==========
;; Quickly display your quick side notes in quick side window.
-;; Side notes live in a plain text file, called notes.txt by default,
-;; in the current directory or any higher directory in the current
-;; hierarchy. i.e. When locating notes, we first look for a notes.txt
-;; file in the current directory, then one directory up, then two
-;; directories up, and so forth.
+;; Side notes live in a plain text file, called notes.txt by default, in
+;; the current directory or any higher directory in the current hierarchy.
+;; i.e. When locating notes, we first look for a notes.txt file in the
+;; current directory, then one directory up, then two directories up, and
+;; so forth.
;; Side notes are displayed in a side window with the command
;; side-notes-toggle-notes.
@@ -45,31 +46,32 @@
;; display a separate notes file in a lower side window when the command
;; side-notes-toggle-notes is prefixed with an argument (C-u).
-;; By default, having a notes file in any parent directory will locate
-;; that file rather than visit a non-existing file in the current
-;; directory, but you can override this by prefixing
-;; side-notes-toggle-notes with...
+;; By default, having a notes file in any parent directory will locate that
+;; file rather than visit a non-existing file in the current directory, but
+;; you can override this by prefixing side-notes-toggle-notes with...
-;; - C-u C-u to force visiting side-notes-file within the current
-;; directory.
-;; - C-u C-u C-u to force visiting side-notes-secondary-file within
-;; the current directory.
+;; - C-u C-u to force visiting side-notes-file within the current
+;; directory.
+;; - C-u C-u C-u to force visiting side-notes-secondary-file within
+;; the current directory.
;; Of course, you can use Markdown or Org Mode formatting by changing the
-;; file extensions of side-notes-file and/or
-;; side-notes-secondary-file.
+;; file extensions of side-notes-file and/or side-notes-secondary-file.
;; For more information on how to change the way the side window is
;; displayed, see (info "(elisp) Side Windows")
-;; ## Installation ##
-;; Install from [MELPA stable] then add something like the following to
+;; Installation
+;; ------------
+
+;; Install from [MELPA stable][1] 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
+;; [1]: https://stable.melpa.org/#/side-notes
+;; [2]: https://melpa.org/#/side-notes
;;; Code: