branch: elpa/bind-map
commit 21f972e52d901d11213a97c2d93630ea34cec528
Author: justbur <jus...@burkett.cc>
Commit: justbur <jus...@burkett.cc>
Clarify some parts of README
---
README.org | 15 ++++++++-------
1 file changed, 8 insertions(+), 7 deletions(-)
diff --git a/README.org b/README.org
index e27ec47ab0..5ed28071cf 100644
--- a/README.org
+++ b/README.org
@@ -3,8 +3,8 @@
bind-map is an Emacs package providing the macro =bind-map= which can be used
to
make a keymap available across different "leader keys" including ones tied to
evil states. It is essentially a generalization of the idea of a leader key as
-used in vim or the Emacs [[https://github.com/cofi/evil-leader][evil-leader]]
package. This is probably best explained
-with an example.
+used in vim or the Emacs [[https://github.com/cofi/evil-leader][evil-leader]]
package, and allows for an arbitrary number
+of "leader keys". This is probably best explained with an example.
#+BEGIN_SRC emacs-lisp
(bind-map my-lisp-map
@@ -16,11 +16,12 @@ with an example.
lisp-mode))
#+END_SRC
-This will take =my-lisp-map= and make it available under =M-m= or =SPC= (in
-evil's normal or visual state. See =bind-map-default-evil-states= for the
-defaults.) when one of the specified major mode is active (there is no need to
-make sure the respective modes' packages are loaded before this declaration).
-See the docstring of =bind-map= for more options.
+This will take =my-lisp-map= and make it available under the prefixes (or
+leaders) =M-m= and =SPC=, where the latter is only bound in evil's normal or
+visual state (defaults in =bind-map-default-evil-states=) when one of the
+specified major mode is active (there is no need to make sure the respective
+modes' packages are loaded before this declaration). See the docstring of
+=bind-map= for more options.
The idea behind this package is that you want to organize your personal
bindings
in a series of keymaps separate from built-in mode maps. You can simply add
keys
