summaryrefslogtreecommitdiff
path: root/dot-oh-my-zsh/plugins/chruby/README.md
diff options
context:
space:
mode:
authorlittleblack111 <littleblack11111@gmail.com>2024-06-03 19:56:39 +0800
committerlittleblack111 <littleblack11111@gmail.com>2024-06-03 19:56:39 +0800
commitca968c4e5040f1ff4b5b5e12d9312360d807dcc1 (patch)
tree9900920e8f566794560c1519678e344351d2803b /dot-oh-my-zsh/plugins/chruby/README.md
parent5f3deaff0bf006a1a353e57b82ad48c0e8f143bc (diff)
added submodules, change . -> dot (see man stow --dotfiles)
Diffstat (limited to 'dot-oh-my-zsh/plugins/chruby/README.md')
-rw-r--r--dot-oh-my-zsh/plugins/chruby/README.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/dot-oh-my-zsh/plugins/chruby/README.md b/dot-oh-my-zsh/plugins/chruby/README.md
new file mode 100644
index 00000000..19eb15a8
--- /dev/null
+++ b/dot-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
+```