Add readme

mrjohannchang · Mar 27, 2017 · b8661c6 · b8661c6
1 parent 1ea0b98
commit b8661c6
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,15 @@
+# zsh-interactive-cd
+
+## 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. Source `zsh-interactive-cd.zsh` in `.zshrc`.
+
+## 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.
diff --git a/demo.gif b/demo.gif