chruby: add README (#8238)

This commit is contained in:
Marc Cornellà 2019-10-09 18:13:13 +02:00 committed by GitHub
commit ba57b5c706
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

20
plugins/chruby/README.md Normal file
View file

@ -0,0 +1,20 @@
# chruby plugin
This plugin loads [chruby](https://github.com/postmodern/chruby), a tool that changes the
current Ruby version, and completion and a prompt function to display the Ruby version.
Supports brew and manual installation of chruby.
To use it, add `chruby` to the plugins array in your zshrc file:
```zsh
plugins=(... chruby)
```
## Usage
If you'd prefer to specify an explicit path to load chruby from
you can set variables like so:
```
zstyle :omz:plugins:chruby path /local/path/to/chruby.sh
zstyle :omz:plugins:chruby auto /local/path/to/auto.sh
```