Skip to content

Commit 7f7c8a7

Browse files
committed
update readme, include usage info
1 parent 895d6b1 commit 7f7c8a7

File tree

1 file changed

+16
-2
lines changed

1 file changed

+16
-2
lines changed

readme.md

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,25 @@ Download AppImage package from [Release page](https://github.com/blahgeek/Minion
1010

1111
*Note*: In the first running, the application would needs to build font cache, which could take several minutes.
1212

13-
Hit `ctrl+space` to open Minions.
13+
Keyboard shortcuts:
14+
15+
- `ctrl+space`: show minions window
16+
- `ctrl+shift+space`: show minions window with selected text
17+
18+
- `Up/Down/ctrl+k/ctrl+j`: move up/down
19+
- `[a-z]`: filter items
20+
- `enter`: confirm selection (if valid)
21+
- `space`: enter text for this action (if valid)
22+
- `tab`: open this item with another action
23+
- `ctrl-c`: copy item text
24+
- `esc`: Escape/close
25+
26+
Minions would use `~/.minions/config.toml` for custom config. See `./config/default.toml` for default config.
27+
Note that custom config is not required. The default config would be used if the custom config or certain config section is missing.
1428

1529
## Status
1630

17-
Still in alpha, but usable. Feedback and contribution are welcome.
31+
Still in beta, but usable. Feedback and contribution are welcome.
1832

1933
## Preview
2034

0 commit comments

Comments
 (0)