From 563a3bd188888b479cfdf5c20b6971895815e141 Mon Sep 17 00:00:00 2001 From: Lars Tveito Date: Sun, 24 May 2015 17:51:58 +0200 Subject: [PATCH] Updated README --- README.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index d68bb53..5d43da8 100644 --- a/README.md +++ b/README.md @@ -15,9 +15,9 @@ The package has only been tried on Emacs 24.4 and 24.5, but should work on Emacs Enable the `focus-mode` with M-x focus-mode . -Also, `focus-read-only-mode` is provided, which is optimized for continuous reading. It inhibits change in the buffer, hides the cursor and provides bindings for moving between *things* (defined in [Thing At Point](http://emacswiki.org/emacs/ThingAtPoint). One can toggle `focus-read-only-mode` with M-x focus-read-only-mode or C-c C-q if `focus-mode` is enabled. +Also, `focus-read-only-mode` is provided, which is a mode optimized for continuous reading. It inhibits change in the buffer, hides the cursor and provides bindings for moving between *things* (defined in [Thing At Point](http://emacswiki.org/emacs/ThingAtPoint). One can toggle `focus-read-only-mode` with M-x focus-read-only-mode or C-c C-q if `focus-mode` is enabled. -Some bindings are provided for simple navigation and exiting `focus-read-only-mode`. +Some bindings for simple navigation and exiting `focus-read-only-mode` are provided. Keybinding | Description -------------------|---------------------------- @@ -28,6 +28,12 @@ Keybinding | Description i | Exit `focus-read-only-mode` q | Exit `focus-read-only-mode` +## Configuring + +The amount of dimness can be customized by setting the `focus-dimness` variable, where a positive integer indicates a more dim color (i.e. more blended with the background color of your theme), and a negative integer indicates a less dim color. + +Focus uses the [Thing At Point](http://emacswiki.org/emacs/ThingAtPoint) library to choose what section should be in focus. By default, modes derived from `prog-mode` uses `defun`, and modes derived from `text-mode` uses `sentence`. This a customizable by setting the `focus-mode-to-thing` variable, which is a list containing pairs on the form `(mode . thing)`. + ### Example This is what it looks like: