summaryrefslogtreecommitdiff
path: root/plugins/percol/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/percol/README.md')
-rw-r--r--plugins/percol/README.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/plugins/percol/README.md b/plugins/percol/README.md
new file mode 100644
index 000000000..b262e414e
--- /dev/null
+++ b/plugins/percol/README.md
@@ -0,0 +1,20 @@
+## percol
+
+Provides some useful function to make [percol](https://github.com/mooz/percol) work with zsh history and [jump plugin](https://github.com/robbyrussell/oh-my-zsh/blob/master/plugins/jump/jump.plugin.zsh)
+
+### Requirements
+
+```shell
+pip install percol
+```
+
+And [jump](https://github.com/robbyrussell/oh-my-zsh/blob/master/plugins/jump/jump.plugin.zsh) for `oh-my-zsh` is a optional requirement.
+
+### Usage
+
+For default
+
+- `^-r` bind to `percol_select_history`.You can use it to grep your history with percol.
+
+- `^-b` bind to `percol_select_marks`.You can use it to grep your bookmarks with percol.
+