7d410549cdeb838c45db4225a3b7d63e7098866d

Author
Karolis Mazukna <karolis.mazukna@deepcrawl.com>
Committer
Karolis Mazukna <karolis.mazukna@deepcrawl.com>
Date

Message

Adds chruby plugib README.md

Diff

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