rbfu: add README

2019-12-27 01:54:02 +01:00 · 2019-12-27 01:54:02 +01:00 · 9655377b9e
commit 9655377b9e
parent 4fd2592007
1 changed files with 17 additions and 0 deletions
--- a/plugins/rbfu/README.md
+++ 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.