From 86d0086b562665ab2c52b53b9c7af109cdaac595 Mon Sep 17 00:00:00 2001
From: Sorin Ionescu <sorin.ionescu@gmail.com>
Date: Tue, 12 Jun 2012 21:02:14 -0400
Subject: [PATCH] [Fix #115] Add documentation for ruby

---
 modules/ruby/README.md | 67 ++++++++++++++++++++++++++++++++++++++++++
 modules/ruby/init.zsh  |  8 +++--
 2 files changed, 72 insertions(+), 3 deletions(-)
 create mode 100644 modules/ruby/README.md

diff --git a/modules/ruby/README.md b/modules/ruby/README.md
new file mode 100644
index 0000000..e7083bb
--- /dev/null
+++ b/modules/ruby/README.md
@@ -0,0 +1,67 @@
+Ruby
+====
+
+Configures [Ruby][1] local gem installation, loads version managers, and defines
+aliases.
+
+Local Gem Installation
+----------------------
+
+When a Ruby version manager is not detected, local gems are installed in
+*~/Library/Ruby/Gems/1.8* on Mac OS X.
+
+RVM
+---
+
+An alternative to the above is to use [The Ruby Version Manager (RVM)][2], which
+allows for managing multiple, isolated Ruby installations and gem sets in the
+home directory.
+
+Since RVM is loaded into the shell and is known to override shell commands, it
+may conflict with shell scripts.
+
+rbenv
+-----
+
+An alternative RVM is to use [rbenv][3], which allows for switching between multiple,
+isolated Ruby installations in the home directory.
+
+While it is not as feature rich as RVM, it is not loaded into the shell and is
+not known to cause conflicts with shell scripts.
+
+Bundler
+-------
+
+Manage gems that are not meant to be used as commands, such as application
+dependencies, with [Bundler][4].
+
+Aliases
+-------
+
+### Bundler
+
+  - `b` manages ruby dependencies (`bundle`).
+  - `be` executes a script in the context of the current bundle.
+  - `bi` installs the gems specified in the *Gemfile* in *vendor/bundle*.
+  - `bI` installs the following:
+    - gems specified in the *Gemfile* in *vendor/bundle*.
+    - packages the gems into *vendor/cache*.
+    - appends bundler directories to  *.gitignore*.
+  - `bl` lists all gems in the current bundle.
+  - `bo` opens an installed gem in the editor.
+  - `bp` packages gem files into *vendor/cache*.
+  - `bu` updates gems to their latest version.
+
+Authors
+-------
+
+*The authors of this module should be contacted via the [issue tracker][5].*
+
+  - [Sorin Ionescu](https://github.com/sorin-ionescu)
+
+[1]: http://www.ruby-lang.org
+[2]: https://rvm.io
+[3]: https://github.com/sstephenson/rbenv
+[4]: http://gembundler.com
+[5]: https://github.com/sorin-ionescu/oh-my-zsh/issues
+
diff --git a/modules/ruby/init.zsh b/modules/ruby/init.zsh
index 3bb534a..9b40ed9 100644
--- a/modules/ruby/init.zsh
+++ b/modules/ruby/init.zsh
@@ -1,8 +1,8 @@
 #
-# Configures Ruby gem installation and loads rvm/rbenv.
+# Configures Ruby local gem installation, loads version managers, and defines
+# aliases.
 #
-# Authors:
-#   Sorin Ionescu <sorin.ionescu@gmail.com>
+# Authors: Sorin Ionescu <sorin.ionescu@gmail.com>
 #
 
 # Load RVM into the shell session.
@@ -32,6 +32,8 @@ else
 fi
 
 # Aliases
+
+# Bundler
 alias b='bundle'
 alias be='b exec'
 alias bi='b install --path vendor/bundle'