a7c740b1d7d0033c6de118439c7935962b2a5c2a

Author
Kenny Heaton <kenny.heaton@life.church>
Committer
Marc Cornellà <marc.cornella@live.com>
Date

Message

rbenv: add README (#8293)

Diff

 1diff --git a/plugins/rbenv/README.md b/plugins/rbenv/README.md
 2new file mode 100644
 3index 0000000000000000000000000000000000000000..43a2e93ac7efb277d4e463176346480fd5f440ae
 4--- /dev/null
 5+++ b/plugins/rbenv/README.md
 6@@ -0,0 +1,26 @@
 7+# rbenv plugin
 8+
 9+The primary job of this plugin is to provide `rbenv_prompt_info` which can be added to your theme to include Ruby
10+version and gemset information into your prompt.
11+
12+Some functionality of this plugin will not work unless you also have the rbenv plugin *gemset* installed.
13+https://github.com/jf/rbenv-gemset
14+
15+To use it, add `rbenv` to the plugins array in your zshrc file:
16+```zsh
17+plugins=(... rbenv)
18+```
19+
20+## Alias
21+
22+| Alias          | Command             | Description                      |
23+|----------------|---------------------|----------------------------------|
24+| rubies         | `rbenv versions`    | List the installed Ruby versions |
25+| gemsets        | `rbenv gemset list` | List the existing gemsets        |
26+
27+## Functions
28+
29+* `current_ruby`: The version of Ruby currently being used.
30+* `current_gemset`: The name of the current gemset.
31+* `gems`: Lists installed gems with enhanced formatting and color.
32+* `rbenv_prompt_info`: For adding information to your prompt. Format: `<ruby version>@<current gemset>`.