summaryrefslogtreecommitdiff
path: root/home/.oh-my-zsh/plugins/zsh-interactive-cd/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'home/.oh-my-zsh/plugins/zsh-interactive-cd/README.md')
-rw-r--r--home/.oh-my-zsh/plugins/zsh-interactive-cd/README.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/home/.oh-my-zsh/plugins/zsh-interactive-cd/README.md b/home/.oh-my-zsh/plugins/zsh-interactive-cd/README.md
new file mode 100644
index 0000000..29812a2
--- /dev/null
+++ b/home/.oh-my-zsh/plugins/zsh-interactive-cd/README.md
@@ -0,0 +1,21 @@
+# zsh-interactive-cd
+
+This plugin provides an interactive way to change directories in zsh using fzf.
+
+## Demo
+
+![demo](demo.gif)
+
+## Installation
+
+1. Install [fzf](https://github.com/junegunn/fzf) by following its [installation instruction](https://github.com/junegunn/fzf#installation).
+
+2. Add `zsh-interactive-cd` to your plugin list in `~/.zshrc`:
+
+ ```zsh
+ plugins=(... zsh-interactive-cd)
+ ```
+
+## Usage
+
+Press tab for completion as usual, it'll launch fzf automatically. Check fzf’s [readme](https://github.com/junegunn/fzf#search-syntax) for more search syntax usage.