summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMarc Cornellà <marc.cornella@live.com>2019-10-03 13:52:01 +0200
committerGitHub <noreply@github.com>2019-10-03 13:52:01 +0200
commitd9bb732eac5a734ee662034873b9dbdea84d1184 (patch)
tree487c9d59d33bd003ed3909b59ffbae2a2ee2493f
parentff23aa0bf9851c477b956c89882fdd04e143042e (diff)
parent188eff0653a078ecf67e0a1c6b72de8d61384986 (diff)
downloadzsh-d9bb732eac5a734ee662034873b9dbdea84d1184.tar.gz
zsh-d9bb732eac5a734ee662034873b9dbdea84d1184.tar.bz2
zsh-d9bb732eac5a734ee662034873b9dbdea84d1184.zip
rvm: add README (#8199)
-rw-r--r--plugins/rvm/README.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/plugins/rvm/README.md b/plugins/rvm/README.md
new file mode 100644
index 000000000..9d6fd8f85
--- /dev/null
+++ b/plugins/rvm/README.md
@@ -0,0 +1,19 @@
+# Ruby Version Manager plugin
+
+This plugin adds some utility functions and completions for [Ruby Version Manager](https://rvm.io/).
+
+To use it, add `rvm` to the plugins array in your zshrc file:
+
+```zsh
+plugins=(... rvm)
+```
+
+## Functions
+| Alias | Command |
+|----------------|----------------------|
+| `rb18` | `rvm use ruby-1.8.7` |
+| `rb19` | `rvm use ruby-1.9.3` |
+| `rb20` | `rvm use ruby-2.0.0` |
+| `rb21` | `rvm use ruby-2.1.2` |
+| `rvm-update` | `rvm get head` |
+| `gems` | `gem list` |