From af120ab348f2e1a5a39dec035ed9dcf84189a64e Mon Sep 17 00:00:00 2001
From: Biswakalyan Bhuyan <biswa@surgot.in>
Date: Mon, 3 Oct 2022 21:42:20 +0530
Subject: dotfiles

---
 zsh/oh-my-zsh/plugins/percol/README.md | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)
 create mode 100644 zsh/oh-my-zsh/plugins/percol/README.md

(limited to 'zsh/oh-my-zsh/plugins/percol/README.md')

diff --git a/zsh/oh-my-zsh/plugins/percol/README.md b/zsh/oh-my-zsh/plugins/percol/README.md
new file mode 100644
index 0000000..78c881f
--- /dev/null
+++ b/zsh/oh-my-zsh/plugins/percol/README.md
@@ -0,0 +1,23 @@
+# percol
+
+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.
+
+To use it, add `percol` to the plugins array in your zshrc:
+
+```zsh
+plugins=(... percol)
+```
+
+## Requirements
+
+- `percol`: install with `pip install percol`.
+
+- (_Optional_) [`jump`](https://github.com/ohmyzsh/ohmyzsh/tree/master/plugins/jump) plugin: needs to be
+  enabled before the `percol` plugin.
+
+## Usage
+
+- <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.
-- 
cgit v1.2.3-59-g8ed1b