Skip to content

Commit

Permalink
Add clarification of plugin scope to README
Browse files Browse the repository at this point in the history
There is an issue with users thinking that the WhichKey plugin also sets
keybindings, probably due to the GIF in the README file which gives a
"false" impression. This adaption should clarify this.

Fixes #44 #46
  • Loading branch information
TheBlob42 committed Nov 7, 2023
1 parent 07bd588 commit 09b8398
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,10 @@

[IdeaVim](https://github.com/JetBrains/ideavim) extension that displays available keybindings in a popup similar to [vim-which-key](https://github.com/liuchengxu/vim-which-key)

![idea which key](/assets/idea_which_key.gif)
![idea which key](./assets/idea_which_key.gif)

> Which-Key only displays **available** keybindings, it will not set them for you ([#44](https://github.com/TheBlob42/idea-which-key/issues/44), [#46](https://github.com/TheBlob42/idea-which-key/issues/46))
> For a "complete" setup you might have a look at [intellimacs](https://github.com/MarcoIeni/intellimacs) (which was used for the GIF above)
## Installation

Expand Down

0 comments on commit 09b8398

Please sign in to comment.