summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorAndrew Gallant <jamslam@gmail.com>2017-01-06 22:52:57 -0500
committerAndrew Gallant <jamslam@gmail.com>2017-01-06 22:52:57 -0500
commit8f7b9be356c005435f5612904f38ed5d95cc2aa0 (patch)
treeb1bd81ccf1abf8a58b865a4c1f4c9c6d44c811ea /README.md
parent851799f42be4409d4e2498960725e11d0514a0e7 (diff)
Add docs for shell completion files.
Add small howtos for installing shell completion files to the README and the man page. They are still incomplete. We're missing Zsh and PowerShell. Fixes #262
Diffstat (limited to 'README.md')
-rw-r--r--README.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/README.md b/README.md
index a7e0c01e..f3eb36c1 100644
--- a/README.md
+++ b/README.md
@@ -302,6 +302,16 @@ extensions.
The syntax supported is
[documented as part of Rust's regex library](https://doc.rust-lang.org/regex/regex/index.html#syntax).
+### Shell completions
+
+Shell completion files are included in the release tarball for Bash, Fish, Zsh
+and PowerShell.
+
+For **bash**, move `rg.bash-completion` to `$XDG_CONFIG_HOME/bash_completion`
+or `/etc/bash_completion.d/`.
+
+For **fish**, move `rg.fish` to `$HOME/.config/fish/completions`.
+
### Building
`ripgrep` is written in Rust, so you'll need to grab a