ba57b5c7067821f114fc2075a19e7eca8b4d6c83

Author
Marc Cornellà <marc.cornella@live.com>
Committer
GitHub <noreply@github.com>
Date

Message

chruby: add README (#8238)

Diff

 1diff --git a/plugins/chruby/README.md b/plugins/chruby/README.md
 2new file mode 100644
 3index 0000000000000000000000000000000000000000..d373006a526c8449f6261d0713cecb90f5f3e2be
 4--- /dev/null
 5+++ b/plugins/chruby/README.md
 6@@ -0,0 +1,20 @@
 7+# chruby plugin
 8+
 9+This plugin loads [chruby](https://github.com/postmodern/chruby), a tool that changes the
10+current Ruby version, and completion and a prompt function to display the Ruby version.
11+Supports brew and manual installation of chruby.
12+
13+To use it, add `chruby` to the plugins array in your zshrc file:
14+```zsh
15+plugins=(... chruby)
16+```
17+
18+## Usage
19+
20+If you'd prefer to specify an explicit path to load chruby from
21+you can set variables like so:
22+
23+```
24+zstyle :omz:plugins:chruby path /local/path/to/chruby.sh
25+zstyle :omz:plugins:chruby auto /local/path/to/auto.sh
26+```