diff options
author | Marc Cornellà <hello@mcornella.com> | 2021-11-08 14:01:34 +0100 |
---|---|---|
committer | Marc Cornellà <hello@mcornella.com> | 2021-11-08 14:01:34 +0100 |
commit | 90903779b942a12d273e8d158ad97b252dc74360 (patch) | |
tree | b78cf9638c5b535635df8f0a3ab78602d36e735b /plugins/percol/README.md | |
parent | b2f35a7b98455b2bb8c7c3b11db6aa587e1d28bf (diff) | |
download | zsh-90903779b942a12d273e8d158ad97b252dc74360.tar.gz zsh-90903779b942a12d273e8d158ad97b252dc74360.tar.bz2 zsh-90903779b942a12d273e8d158ad97b252dc74360.zip |
refactor(percol): fix style, bind keys for vi-mode and remove dependencies
Diffstat (limited to 'plugins/percol/README.md')
-rw-r--r-- | plugins/percol/README.md | 23 |
1 files changed, 13 insertions, 10 deletions
diff --git a/plugins/percol/README.md b/plugins/percol/README.md index ec5de4f86..78c881f55 100644 --- a/plugins/percol/README.md +++ b/plugins/percol/README.md @@ -1,20 +1,23 @@ -## percol +# percol -Provides some useful function to make [percol](https://github.com/mooz/percol) work with zsh history and [jump plugin](https://github.com/ohmyzsh/ohmyzsh/blob/master/plugins/jump/jump.plugin.zsh) +Provides some useful function to make [percol](https://github.com/mooz/percol) work with zsh history and +the [jump plugin](https://github.com/ohmyzsh/ohmyzsh/tree/master/plugins/jump), optionally. -### Requirements +To use it, add `percol` to the plugins array in your zshrc: -```shell -pip install percol +```zsh +plugins=(... percol) ``` -And [jump](https://github.com/ohmyzsh/ohmyzsh/blob/master/plugins/jump/jump.plugin.zsh) for `oh-my-zsh` is a optional requirement. +## Requirements -### Usage +- `percol`: install with `pip install percol`. -For default +- (_Optional_) [`jump`](https://github.com/ohmyzsh/ohmyzsh/tree/master/plugins/jump) plugin: needs to be + enabled before the `percol` plugin. -- `^-r` bind to `percol_select_history`.You can use it to grep your history with percol. +## Usage -- `^-b` bind to `percol_select_marks`.You can use it to grep your bookmarks with percol. +- <kbd>CTRL-R</kbd> (bound to `percol_select_history`): you can use it to grep your history with percol. +- <kbd>CTRL-B</kbd> (bound to `percol_select_marks`): you can use it to grep your jump bookmarks with percol. |