branch: elpa/guru-mode
commit 1f50aa9a392dd8722e240b48cca907062f2614d7
Author: Bozhidar Batsov <bozhi...@batsov.com>
Commit: Bozhidar Batsov <bozhi...@batsov.com>
[#7] Add a note about modifying the list of keybindings
---
README.md | 19 +++++++++++++++++--
1 file changed, 17 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md
index ada7ce3..6ba7730 100644
--- a/README.md
+++ b/README.md
@@ -2,8 +2,12 @@
## Synopsis
-Guru mode disables some common keybindings and suggests the use of the
-established Emacs alternatives instead.
+Guru mode disables (or warns on) some generic keybindings and suggests the use
of the
+established and more efficient Emacs alternatives instead. Here are a few
examples:
+
+* It will teach you to avoid the arrow keys and use keybindings like `C-f`,
`C-b`, etc.
+* It will teach you to avoid keybindings using Home, End, etc.
+* It will teach you to avoid Delete/Backspace.
## Installation
@@ -50,6 +54,17 @@ If you only want to get warnings when you the arrow keys use
the following confi
(setq guru-warn-only t)
```
+You can extend the list of keybindings covered by `guru-mode` like this:
+
+``` emacs-lisp
+(add-to-list 'guru-affected-bindings-list '("<C-left>" "M-b" left-word))
+```
+
+The list you're adding is of the format (discouraged keybinding, recommended
keybinding, command).
+
+**Note:** `guru-mode` operates only on global keybindings and it will never
interfere with
+some mode-specific keybindings.
+
## Known issues
Check out the project's
