update README.md

README.md

@@ -1,15 +1,27 @@
 # z.lua
+
 z - jump around (lua implementation for running on both unix & windows)
 
-Licensed under MIT license.
 
 ## Features
 
 - 10x times faster than fasd and autojump
-- 3x times faster than rupa/z
+- 3x times faster than z.sh
 - supports posix shells: bash, zsh, dash, sh, busybox, and etc.
 - supports Windows cmd (with clink) and cmder
 
+## USE
+
+```bash
+z foo       # cd to most frecent dir matching foo
+z foo bar   # cd to most frecent dir matching foo and bar
+z -r foo    # cd to highest ranked dir matching foo
+z -t foo    # cd to most recently accessed dir matching foo
+z -l foo    # list matches instead of cd
+z -c foo    # restrict matches to subdirs of $PWD
+z -e foo    # echo the best match, don't cd
+```
+
 ## Install
 
 - bash:
@@ -40,3 +52,7 @@ Licensed under MIT license.
 - set $_ZL_DATA in .bashrc/.zshrc to change the datafile (default ~/.zlua).
 - set $_ZL_NO_PROMPT_COMMAND if you're handling PROMPT_COMMAND yourself.
 - set $_ZL_EXCLUDE_DIRS to an array of directories to exclude.
+
+## Credit
+
+Licensed under MIT license.