Package: discover-my-major / 1.0-1

0002-update-README.diff Patch series | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
From: Lev Lamberov <dogsleg@debian.org>
Subject: Update README.md from upstream

This patch updates README.md to the current version from upstream. Updated
version contains more useful information on usage of the package.

--- a/README.md
+++ b/README.md
@@ -30,10 +30,18 @@ Packages are available in [MELPA](http:/
 
 ## Usage
 
-In any mode you should be able to summon the popup by invoking `M-x discover-my-major` which will show you a list of key bindings with descriptions.
+In any mode you should be able to summon the popup to discover the commands defined by the current buffer's `major-mode`, by invoking `M-x discover-my-major`; and for any of the buffer's active minor modes, by invoking `M-x discover-my-mode`. Each of these commands which will show you a list of key bindings defined by that mode in the current buffer along with their descriptions.
 
-The recommended key binding is `C-h C-m` (please be aware that by default `C-h C-m` is bound to `view-order-manuals` so please use another binding if you want to keep that):
+The recommended key binding is `C-h C-m`, but be aware that by default `C-h C-m` is bound to `view-order-manuals`. If the `help+` package is installed, this key is bound to `help-on-click/key` by default.
 
 ```lisp
 (global-set-key (kbd "C-h C-m") 'discover-my-major)
+(global-set-key (kbd "C-h M-m") 'discover-my-mode)
+```
+
+Or alternatively, to avoid overriding `C-h C-m`:
+
+```lisp
+(global-set-key (kbd "C-h M-m") 'discover-my-major)
+(global-set-key (kbd "C-h M-S-M") 'discover-my-mode)
 ```