summaryrefslogtreecommitdiff
path: root/plugins/ripgrep/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/ripgrep/README.md')
-rw-r--r--plugins/ripgrep/README.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/plugins/ripgrep/README.md b/plugins/ripgrep/README.md
new file mode 100644
index 000000000..794b105ee
--- /dev/null
+++ b/plugins/ripgrep/README.md
@@ -0,0 +1,13 @@
+# ripgrep
+
+This plugin adds completion for the text search tool [`ripgrep`](https://github.com/BurntSushi/ripgrep), also known as `rg`.
+
+To use it, add `ripgrep` to the plugins array in your zshrc file:
+
+```zsh
+plugins=(... ripgrep)
+```
+
+Completion is taken from the ripgrep release [`0.10.0`](https://github.com/BurntSushi/ripgrep/releases/tag/0.10.0).
+
+Updated on September 27th, 2018.