Skip to content

Commit 151d19c

Browse files
committed
rewrite ‘basic usage’ section in readme to mention the built-in keymap
1 parent 88f74e5 commit 151d19c

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

README.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,17 +18,23 @@ The `evil-easymotion` API has changed to use keyword arguments. The required cha
1818

1919
Basic Usage
2020
===========
21-
To define easymotions for all motions that evil defines by default, add
21+
22+
`evil-easymotion` comes with predefined easymotions for all basic motions that evil defines by default, and provides key bindings for these using the standard evil keys in the built-in keymap `evilem-map`. To make these available for use, bind this keymap to a prefix:
23+
2224
```emacs
2325
(evilem-default-keybindings "SPC")
2426
```
25-
This binds all motions under the prefix `SPC` in `evil-motion-state-map`. This is not done by default for motions defined manually. You will need to supply the prefix.
2627

27-
Or, if you prefer more granular control:
28+
This binds all motions under the prefix <kbd>SPC</kbd> in `evil-motion-state-map`. Type <kbd>SPC</kbd><kbd>j</kbd> to give it a try.
29+
30+
For motions defined manually, you need to bind the keys yourself, for instance using `evilem-define`:
31+
2832
```emacs
2933
(evilem-define (kbd "SPC w") 'evil-forward-word-begin)
3034
```
3135

36+
(This is just an example; this functionality is already available by default.)
37+
3238
You can always drop by [the wiki](https://github.com/PythonNut/evil-easymotion/wiki) for more tips.
3339

3440

0 commit comments

Comments
 (0)