summaryrefslogtreecommitdiff
path: root/plugins/ripgrep/README.md
diff options
context:
space:
mode:
authorMarc Cornellà <marc.cornella@live.com>2019-03-25 19:51:25 +0100
committerMarc Cornellà <marc.cornella@live.com>2019-03-25 19:51:25 +0100
commit1e7033d6600823d90cbadcaa7ea696ee7a88afe8 (patch)
treea884996008b7925814d5d1d8646c402ee73c25ee /plugins/ripgrep/README.md
parentf6a9a0a49855666f3311a2db040b9b27969da2bc (diff)
parent9538eae3d732f6c1e59136f0fb2dce7f98a129a1 (diff)
downloadzsh-1e7033d6600823d90cbadcaa7ea696ee7a88afe8.tar.gz
zsh-1e7033d6600823d90cbadcaa7ea696ee7a88afe8.tar.bz2
zsh-1e7033d6600823d90cbadcaa7ea696ee7a88afe8.zip
Merge pull request #7166 from jounathaen/master
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.