summaryrefslogtreecommitdiff
path: root/plugins/chruby/README.md
diff options
context:
space:
mode:
authorMarc Cornellà <marc.cornella@live.com>2019-10-09 18:13:13 +0200
committerGitHub <noreply@github.com>2019-10-09 18:13:13 +0200
commitba57b5c7067821f114fc2075a19e7eca8b4d6c83 (patch)
tree32883f1e00798146f8f108e16567c694c74bb72d /plugins/chruby/README.md
parent11e23477527a0314ffbed74a3d061ae76034da15 (diff)
parent98cd133c4d15c1a147679cc00c0bd924fd91f11c (diff)
downloadzsh-ba57b5c7067821f114fc2075a19e7eca8b4d6c83.tar.gz
zsh-ba57b5c7067821f114fc2075a19e7eca8b4d6c83.tar.bz2
zsh-ba57b5c7067821f114fc2075a19e7eca8b4d6c83.zip
chruby: add README (#8238)
Diffstat (limited to 'plugins/chruby/README.md')
-rw-r--r--plugins/chruby/README.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/plugins/chruby/README.md b/plugins/chruby/README.md
new file mode 100644
index 000000000..d373006a5
--- /dev/null
+++ b/plugins/chruby/README.md
@@ -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
+```