helpful

commit 3b2141975f9f54f7433b9ea9947df0849864a26a
parent 2d68df222e432eb9f1f3ccdf558cbd2542254cb8
Author: Wilfred Hughes <me@wilfred.me.uk>
Date:   Wed,  6 Dec 2017 22:29:57 +0000

Document usage

Show how to set up keybindings, and stress the difference between
describe-function, helpful-function, and helpful-callable.

Closes #39
Closes #60

Diffstat:
M
README.md
 | 
32
++++++++++++++++++++++++++++++++
M
helpful.el
 | 
1
+

2 files changed, 33 insertions(+), 0 deletions(-)
diff --git a/README.md b/README.md
@@ -5,6 +5,38 @@ much more contextual information.
 
 ![screenshot](screenshots/helpful.png)
 
+## Usage
+
+Install from MELPA, then call one of the following commands:
+
+* `helpful-callable`
+* `helpful-function`
+* `helpful-macro`
+* `helpful-command`
+* `helpful-key`
+* `helpful-variable`
+* `helpful-at-point`
+
+If you want to replace the default Emacs help keybindings, you can do
+so:
+
+``` emacs-lisp
+;; Note that the built-in `describe-function' includes both functions
+;; and macros. `helpful-function' is functions only, so we provide
+;; `helpful-callable' as a drop-in replacement.
+(global-set-key (kbd "C-h f") #'helpful-callable)
+
+(global-set-key (kbd "C-h v") #'helpful-variable)
+(global-set-key (kbd "C-h k") #'helpful-key)
+```
+
+I also recommend you configure `helpful-at-point` to a convenient
+keybinding:
+
+``` emacs-lisp
+(global-set-key (kbd "C-c C-.") #'helpful-at-point)
+```
+
 ## Features
 
 ### Source code
diff --git a/helpful.el b/helpful.el
@@ -31,6 +31,7 @@
 ;;
 ;; * helpful-function
 ;; * helpful-command
+;; * helpful-key
 ;; * helpful-macro
 ;; * helpful-callable
 ;; * helpful-variable