Skip to content

Commit

Permalink
update readme, include usage info
Browse files Browse the repository at this point in the history
  • Loading branch information
blahgeek committed Jul 15, 2017
1 parent 895d6b1 commit 7f7c8a7
Showing 1 changed file with 16 additions and 2 deletions.
18 changes: 16 additions & 2 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,25 @@ Download AppImage package from [Release page](https://github.com/blahgeek/Minion

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

Hit `ctrl+space` to open Minions.
Keyboard shortcuts:

- `ctrl+space`: show minions window
- `ctrl+shift+space`: show minions window with selected text

- `Up/Down/ctrl+k/ctrl+j`: move up/down
- `[a-z]`: filter items
- `enter`: confirm selection (if valid)
- `space`: enter text for this action (if valid)
- `tab`: open this item with another action
- `ctrl-c`: copy item text
- `esc`: Escape/close

Minions would use `~/.minions/config.toml` for custom config. See `./config/default.toml` for default config.
Note that custom config is not required. The default config would be used if the custom config or certain config section is missing.

## Status

Still in alpha, but usable. Feedback and contribution are welcome.
Still in beta, but usable. Feedback and contribution are welcome.

## Preview

Expand Down

0 comments on commit 7f7c8a7

Please sign in to comment.