summaryrefslogtreecommitdiff
path: root/plugins/zsh-interactive-cd/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/zsh-interactive-cd/README.md')
-rw-r--r--plugins/zsh-interactive-cd/README.md22
1 files changed, 7 insertions, 15 deletions
diff --git a/plugins/zsh-interactive-cd/README.md b/plugins/zsh-interactive-cd/README.md
index c8337fbc8..4bffbf04a 100644
--- a/plugins/zsh-interactive-cd/README.md
+++ b/plugins/zsh-interactive-cd/README.md
@@ -1,23 +1,15 @@
# zsh-interactive-cd
-This plugin adds a fish-like interactive tab completion for the `cd` command.
+## Demo
-To use it, add `zsh-interactive-cd` to the plugins array of your zshrc file:
-```zsh
-plugins=(... zsh-interactive-cd)
-```
+![demo](demo.gif)
-![demo](https://user-images.githubusercontent.com/1441704/74360670-cb202900-4dc5-11ea-9734-f60caf726e85.gif)
+## Installation
-## 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.
+1. Install [fzf](https://github.com/junegunn/fzf) by following its [installation instruction](https://github.com/junegunn/fzf#installation).
-## Requirements
+2. Source `zsh-interactive-cd.plugin.zsh` in `.zshrc`.
-This plugin requires [fzf](https://github.com/junegunn/fzf). Install it by following
-its [installation instructions](https://github.com/junegunn/fzf#installation).
-
-## Author
+## Usage
-[Henry Chang](https://github.com/changyuheng)
+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.