summaryrefslogtreecommitdiff
path: root/plugins/rbfu
diff options
context:
space:
mode:
authorMarc Cornellà <marc.cornella@live.com>2019-12-27 01:54:02 +0100
committerMarc Cornellà <marc.cornella@live.com>2019-12-27 01:54:02 +0100
commit9655377b9e02284188deddd3829159a0e35cc48f (patch)
treea52ed58fa889fbef64690d99805df270442c8b6b /plugins/rbfu
parent4fd25920070f85bf358d297e79af1e85aac07f5a (diff)
downloadzsh-9655377b9e02284188deddd3829159a0e35cc48f.tar.gz
zsh-9655377b9e02284188deddd3829159a0e35cc48f.tar.bz2
zsh-9655377b9e02284188deddd3829159a0e35cc48f.zip
rbfu: add README
Diffstat (limited to 'plugins/rbfu')
-rw-r--r--plugins/rbfu/README.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/plugins/rbfu/README.md b/plugins/rbfu/README.md
new file mode 100644
index 000000000..f1f9fa2f7
--- /dev/null
+++ b/plugins/rbfu/README.md
@@ -0,0 +1,17 @@
+# rbfu plugin
+
+This plugin starts [rbfu](https://github.com/hmans/rbfu), a minimal Ruby version
+manager, and adds some useful functions.
+
+To use it, add `rbfu` to the plugins array in your zshrc file:
+```zsh
+plugins=(... rbfu)
+```
+
+**Note: `rbfu` is deprecated and should no longer be used.**
+
+## Functions
+
+- `rbfu-rubies`: lists all installed rubies available to rbfu.
+
+- `rvm_prompt_info`: shows the Ruby version being used with rbfu.