From 99a16c554206f8fd63cf59b0eb241e167fa8c81f Mon Sep 17 00:00:00 2001
From: Pritesh Mehta <pritesh@phatforge.com>
Date: Thu, 13 Mar 2008 12:12:04 +0000
Subject: [PATCH] Documentation update

Update some documentation to show the use of paths for submodules.
---
 .gitignore    | 1 +
 README.txt    | 4 ++--
 bin/git-rails | 6 +++++-
 3 files changed, 8 insertions(+), 3 deletions(-)

diff --git a/.gitignore b/.gitignore
index 5102a15..362eabe 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,2 +1,3 @@
 pkg
 email.txt
+.todo*
diff --git a/README.txt b/README.txt
index 372b02b..718bcbd 100644
--- a/README.txt
+++ b/README.txt
@@ -16,8 +16,8 @@ Tools to help using git with rails
 == SYNOPSIS:
 
   git-rails init {remote git repository}
-  git-rails install [remote plugin repository]
-  git-rails update plugin-name
+  git-rails install <remote plugin repository> [plugin name||path]
+  git-rails update <plugin-name||path>
 
 == REQUIREMENTS:
 
diff --git a/bin/git-rails b/bin/git-rails
index 9123d24..2ad41ac 100644
--- a/bin/git-rails
+++ b/bin/git-rails
@@ -54,12 +54,14 @@ Main {
 
   mode(:install){
     description <<-txt
-      installs a plugin from a remote git repository
+      installs a plugin from a remote git repository as a git submodule.
+      installs to a path if provided e.g. vendor/rails
 
     txt
 
     examples <<-txt
       . git-rails install git://gitorious.org/rur/mainline.git plugin-name
+      . git-rails install git://github.com/koz/rails.git vendor/rails
     txt
 
     mixin :argument_remote, :argument_plugin_name
@@ -72,10 +74,12 @@ Main {
   mode(:update){
     description <<-txt
       updates a plugin from original source
+      updates a submodule as declared by the path
     txt
 
     examples <<-txt
       . git-rails update plugin-name
+      . git-rails update vendor/plugin
     txt
 
     mixin :argument_plugin_name