Browse Source

Adds chruby plugib README.md

Karolis Mazukna 5 years ago
parent
commit
7d410549cd
1 changed files with 19 additions and 0 deletions
  1. 19 0
      plugins/chruby/README.md

+ 19 - 0
plugins/chruby/README.md

@@ -0,0 +1,19 @@
+# chruby plugin
+
+This plugin loads the [chruby](https://github.com/postmodern/chruby). 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
+```