From 1d1434e4b9d152d84cc68b2d97ee2f90c5388f90 Mon Sep 17 00:00:00 2001 From: skywind3000 Date: Wed, 21 Nov 2018 18:05:24 +0800 Subject: [PATCH] update doc --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index c15e8e4..7e39d03 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,8 @@ # z.lua -z - jump around (lua implementation for running on both unix & windows) +z - jump around (lua implementation for running on both unix & windows). + +An alternative to [z.sh](https://github.com/rupa/z) with windows and posix shells support and performance improving. ## Features @@ -9,6 +11,7 @@ z - jump around (lua implementation for running on both unix & windows) - **3x** times faster than **z.sh** - supports **posix shells**: bash, zsh, dash, sh, busybox, and etc. - supports Windows cmd (with clink) and cmder +- self contained, no dependence on awk ## USE @@ -42,6 +45,8 @@ z -e foo # echo the best match, don't cd eval "$(lua /path/to/z.lua --init posix)" + (sh, dash and busybox have been tested) + - Windows (with clink): - copy z.lua and z.cmd to clink's home directory