branch: externals/olivetti
commit 26f3db0bc37324444e41a1d4797056b61b56b004
Author: Paul Rankin <he...@paulwrankin.com>
Commit: Paul Rankin <he...@paulwrankin.com>
Updated README/Commentary
---
README.md | 10 +++++++---
olivetti.el | 8 ++++++--
2 files changed, 13 insertions(+), 5 deletions(-)
diff --git a/README.md b/README.md
index 72a7bb5..eef3d98 100644
--- a/README.md
+++ b/README.md
@@ -18,12 +18,16 @@ Features
to keep the text comfortably in the middle of the window.
- Text body width can be the number of characters (an integer) or a
fraction of the window width (a float between 0.0 and 1.0).
-- Interactively change body width with `olivetti-expand`,
- `olivetti-shrink` and `olivetti-set-width`.
+- Interactively change body width with:
+ `olivetti-shrink` <kbd>C-c [</kbd>
+ `olivetti-expand` <kbd>C-c ]</kbd>
+ and `olivetti-set-width`.
- If `olivetti-body-width` is an integer, the text body width will scale
with use of `text-scale-mode`, whereas if a fraction (float) then the
text body width will remain at that fraction.
-- Optionally hide the modeline for distraction-free writing.
+- Optionally remember the state of `visual-line-mode` on entry and
+ recall its state on exit.
+- Optionally hide the mode-line for distraction-free writing.
Requirements
------------
diff --git a/olivetti.el b/olivetti.el
index 1a3d0ad..67962bc 100644
--- a/olivetti.el
+++ b/olivetti.el
@@ -32,11 +32,15 @@
;; to keep the text comfortably in the middle of the window.
;; - Text body width can be the number of characters (an integer) or a
;; fraction of the window width (a float between 0.0 and 1.0).
-;; - Interactively change body width with `olivetti-expand`,
-;; `olivetti-shrink` and `olivetti-set-width`.
+;; - Interactively change body width with:
+;; `olivetti-shrink` C-c [
+;; `olivetti-expand` C-c ]
+;; and `olivetti-set-width`.
;; - If `olivetti-body-width` is an integer, the text body width will scale
;; with use of `text-scale-mode`, whereas if a fraction (float) then the
;; text body width will remain at that fraction.
+;; - Optionally remember the state of `visual-line-mode` on entry and
+;; recall its state on exit.
;; - Optionally hide the mode-line for distraction-free writing.
;; Requirements
