summaryrefslogtreecommitdiff
path: root/oh-my-zsh/plugins/chruby/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'oh-my-zsh/plugins/chruby/README.md')
-rw-r--r--oh-my-zsh/plugins/chruby/README.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/oh-my-zsh/plugins/chruby/README.md b/oh-my-zsh/plugins/chruby/README.md
new file mode 100644
index 0000000..19eb15a
--- /dev/null
+++ b/oh-my-zsh/plugins/chruby/README.md
@@ -0,0 +1,21 @@
+# 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:
+
+```zsh
+zstyle :omz:plugins:chruby path /local/path/to/chruby.sh
+zstyle :omz:plugins:chruby auto /local/path/to/auto.sh
+```