From 1930d2e3c5a597a37594af623e4d4dfe8e402969 Mon Sep 17 00:00:00 2001
From: David Vazgenovich Shakaryan <dvshakaryan@gmail.com>
Date: Mon, 30 Jun 2014 23:01:35 -0700
Subject: Minor changes and documentation cleanup.
---
README | 32 ++++++++++++++++++++++++--------
1 file changed, 24 insertions(+), 8 deletions(-)
(limited to 'README')
diff --git a/README b/README
index d20736b..f7ce5e8 100644
--- a/README
+++ b/README
@@ -4,20 +4,28 @@ https://github.com/omp/rbpm
Manage multiple Ruby installations with no black magic.
-INFO
+NOTES
- rbpm only manages rubies located in the ~/.rubies directory. This
- behaviour can be changed by setting the RUBIES_PATH environment
- variable to some other location.
-
- rbpm does not display information about rubies it does not manage,
+ rbpm only manages rubies located in the ~/.rubies directory. This behaviour
+ can be changed by setting the RUBIES_PATH environment variable to some other
+ location. rbpm does not display information about rubies it does not manage,
such as any system-wide install.
+ rbpm performs a substring match when selecting a ruby, using the highest
+ matching directory when there are multiple matches.
+
+
+DEPENDENCIES
+
+ bash (>= 4.0)
+ coreutils (sort)
+ findutils (xargs)
+
INSTALLING
- Save the script to a safe location, then add the following function
- to your ~/.bashrc or equivalent file:
+ Save the script to a safe location, then add the following function to your
+ ~/.bashrc or equivalent file:
rbpm() { source <(/path/to/rbpm.sh "${@}"); }
@@ -74,7 +82,15 @@ USAGE
Adding /home/omp/.rubies/ruby-1.8.7-p374/bin to PATH.
+AUTHORS
+
+ David Vazgenovich Shakaryan
+
+
LICENSE
Distributed under the terms of the MIT License.
See included COPYING file for the full license text.
+
+
+# vim: set sw=4 sts=4 ts=4 et tw=79 spell spl=en :
--
cgit v1.2.3-70-g09d2