Skip to content

Commit 99a16c5

Browse files
committed
Documentation update
Update some documentation to show the use of paths for submodules.
1 parent 5970fa9 commit 99a16c5

File tree

3 files changed

+8
-3
lines changed

3 files changed

+8
-3
lines changed

.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
11
pkg
22
email.txt
3+
.todo*

README.txt

+2-2
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@ Tools to help using git with rails
1616
== SYNOPSIS:
1717

1818
git-rails init {remote git repository}
19-
git-rails install [remote plugin repository]
20-
git-rails update plugin-name
19+
git-rails install <remote plugin repository> [plugin name||path]
20+
git-rails update <plugin-name||path>
2121

2222
== REQUIREMENTS:
2323

bin/git-rails

+5-1
Original file line numberDiff line numberDiff line change
@@ -54,12 +54,14 @@ Main {
5454

5555
mode(:install){
5656
description <<-txt
57-
installs a plugin from a remote git repository
57+
installs a plugin from a remote git repository as a git submodule.
58+
installs to a path if provided e.g. vendor/rails
5859

5960
txt
6061

6162
examples <<-txt
6263
. git-rails install git://gitorious.org/rur/mainline.git plugin-name
64+
. git-rails install git://github.com/koz/rails.git vendor/rails
6365
txt
6466

6567
mixin :argument_remote, :argument_plugin_name
@@ -72,10 +74,12 @@ Main {
7274
mode(:update){
7375
description <<-txt
7476
updates a plugin from original source
77+
updates a submodule as declared by the path
7578
txt
7679

7780
examples <<-txt
7881
. git-rails update plugin-name
82+
. git-rails update vendor/plugin
7983
txt
8084

8185
mixin :argument_plugin_name

0 commit comments

Comments
 (0)