summaryrefslogtreecommitdiff
path: root/plugins/fzf/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/fzf/README.md')
-rw-r--r--plugins/fzf/README.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/plugins/fzf/README.md b/plugins/fzf/README.md
new file mode 100644
index 000000000..b3a434347
--- /dev/null
+++ b/plugins/fzf/README.md
@@ -0,0 +1,19 @@
+# fzf
+
+This plugin enables [junegunn's fzf](https://github.com/junegunn/fzf) fuzzy auto-completion and key bindings
+
+```zsh
+# Set fzf installation directory path
+export FZF_BASE=/path/to/fzf/install/dir
+
+# Uncomment the following line to disable fuzzy completion
+# export DISABLE_FZF_AUTO_COMPLETION="true"
+
+# Uncomment the following line to disable key bindings (CTRL-T, CTRL-R, ALT-C)
+# export DISABLE_FZF_KEY_BINDINGS="true"
+
+plugins=(
+ ...
+ fzf
+)
+```