From 8b74d50f1fabb28b0fe58eff651847d1e5b661dd Mon Sep 17 00:00:00 2001 From: Chris Lane Date: Sun, 2 Feb 2020 14:40:23 -0500 Subject: [PATCH] chore: updates README Edits the `README` to provid updated information regarding the shell autocompletion scripts and `fzf` integration. --- README.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index fdf979a..99b6049 100644 --- a/README.md +++ b/README.md @@ -193,9 +193,17 @@ cheat -p personal -t networking --regex -s '(?:[0-9]{1,3}\.){3}[0-9]{1,3}' Advanced Usage -------------- -`cheat` may be integrated with [fzf][]. See [fzf.bash][bash] for instructions. -(Support for other shells will be added in future releases.) +Shell autocompletion is currently available for the `bash` and `fish` shells. +Copy the relevant [completion script][completion-scripts] into the appropriate +directory on your filesystem to enable autocompletion. (This directory will +vary depending on operating system and shell specifics.) +Additionally, `cheat` supports enhanced autocompletion via integration with +[fzf][]. (This feature is currently available on bash only.) To enable `fzf` +integration: + +1. Ensure that `fzf` is available on your `$PATH` +2. Set an envvar: `export CHEAT_USE_FZF=true` [Releases]: https://github.com/cheat/cheat/releases [bash]: https://github.com/cheat/cheat/blob/master/scripts/fzf.bash