[nongnu] elpa/bind-map d7aee3c6ab 09/97: Note helper funcs in README

[ELPA Syncer]

branch: elpa/bind-map
commit d7aee3c6ab82dbc4803113dd44c124df600154e1
Author: justbur <justin@burkett.cc>
Commit: justbur <justin@burkett.cc>

    Note helper funcs in README
---
 README.org | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)

diff --git a/README.org b/README.org
index 5ed28071cf..9c867e80b1 100644
--- a/README.org
+++ b/README.org
@@ -28,3 +28,28 @@ in a series of keymaps separate from built-in mode maps. You 
can simply add keys
 using the built-in =define-key= to =my-lisp-map= for example, and a declaration
 like the one above will take care of ensuring that these bindings are available
 in the correct places.
+
+** Binding keys in the maps
+You may use the built-in =define-key= which will function as intended.
+=bind-key= (part of [[https://github.com/jwiegley/use-package][use-package]]) 
is another option. For those who want a
+different interface. The following functions are also provided, which both just
+use =define-key= internally, but allow for multiple bindings without much 
syntax.
+
+#+BEGIN_SRC emacs-lisp
+(bind-map-set-keys my-lisp-map
+  "c" 'compile
+  "C" 'check
+  ;; ...
+  )
+(bind-map-set-key-defaults my-lisp-map
+  "c" 'compile
+  "C" 'check
+  ;; ...
+  )
+#+END_SRC
+
+The second function only adds the bindings if there is no existing binding for
+that key. It is probably only useful for shared configurations, where you want
+to provide a default binding but don't want that binding to overwrite one made
+by the user. Note the keys in both functions are strings that are passed to
+=kbd= before binding them.