Browse Source

rvm: add README (#8199)

Marc Cornellà 4 years ago
parent
commit
d9bb732eac
1 changed files with 19 additions and 0 deletions
  1. 19 0
      plugins/rvm/README.md

+ 19 - 0
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`           |