README.md in shaft-0.7 vs README.md in shaft-0.8

- old
+ new

@@ -20,18 +20,18 @@ $ gem install shaft ## Usage -Your tunnel configurations need to be stored as -[YAML](http://www.yaml.org) files on your `~/.shaft/` dir. +Your tunnel configurations need to be stored as records in +a [YAML](http://www.yaml.org) formatted `~/.shaft` file. See 'Configuration' for instructions on how to format these files. * Use `shaft all` to get a list of all available tunnels. -* Use `shaft list` to see which tunnels are currently active. +* Use `shaft active` to see which tunnels are currently active. - You could use the `--short` option to get only the names of those lines (this could be useful to insert into your shell prompt. Just saying). * `shaft start [NAME]` would start the tunnel of the same name. * `shaft stop [NAME]` would stop the tunnel of the given name. @@ -57,9 +57,20 @@ Calling Shaft with `$ shaft start foobar` would be equivalent to running: $ ssh -N -p 22 user@remote-host -L 9999:host:8888 + +## ZSH Completions + +Shaft includes a setup file for automatic completion of tunnel names if you use the ZSH shell. + +To install it, you can run: + + $ shaft completions >> ~/.zshrc + +(Or output it to any file that your `.zshrc` includes). +Don't forget to restart your shell! ## Contributing 1. Fork it 2. Create your feature branch (`git checkout -b my-new-feature`)