Skip to content

Commit

Permalink
Documentation update
Browse files Browse the repository at this point in the history
Update some documentation to show the use of paths for submodules.
  • Loading branch information
jasherai committed Mar 13, 2008
1 parent 5970fa9 commit 99a16c5
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 3 deletions.
1 change: 1 addition & 0 deletions .gitignore
@@ -1,2 +1,3 @@
pkg
email.txt
.todo*
4 changes: 2 additions & 2 deletions README.txt
Expand Up @@ -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:

Expand Down
6 changes: 5 additions & 1 deletion bin/git-rails
Expand Up @@ -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
Expand All @@ -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
Expand Down

0 comments on commit 99a16c5

Please sign in to comment.