Browse files

update readme

  • Loading branch information...
1 parent 4bc5397 commit 9ed9a56d72d4bbc49667688c485cc2d034976710 @alexch alexch committed Jun 9, 2012
Showing with 19 additions and 14 deletions.
  1. +19 −14 README.rdoc
View
33 README.rdoc
@@ -41,20 +41,24 @@ Also, if you pass the -r option, it'll annotate routes.rb with the output of "ra
== INSTALL
+Into Gemfile from rubygems.org:
+
+ gem 'annotate', ">=2.5.0.pre1"
+
Into Gemfile from Github:
- gem 'annotate', :git => 'git://github.com/MrJoy/annotate_models.git'
+ gem 'annotate', :git => 'git://github.com/ctran/annotate_models.git'
Into environment gems From rubygems.org:
gem install annotate
Into environment gems from Github checkout:
- git clone git://github.com/MrJoy/annotate_models.git annotate_models
- cd annotate_models
- rake build
- gem install pkg/annotate-*.gem
+ git clone git://github.com/ctran/annotate_models.git annotate_models
+ cd annotate_models
+ rake build
+ gem install pkg/annotate-*.gem
== USAGE
@@ -63,23 +67,23 @@ Into environment gems from Github checkout:
To annotate all your models, tests, fixtures, etc.:
cd /path/to/app
- annotate_models
+ annotate
To annotate your models and tests:
- annotate_models --exclude fixtures
+ annotate --exclude fixtures
To annotate just your models:
- annotate_models --exclude tests,fixtures
+ annotate --exclude tests,fixtures
To annotate routes.rb:
- annotate_models -r
+ annotate -r
To remove annotations:
- annotate_models -d
+ annotate -d
To automatically annotate after running 'rake db:migrate', ensure you've added
annotate_models to your Rails project's Gemfile, and run this:
@@ -110,14 +114,15 @@ anywhere in the file:
-R, --require path Additional files to require before loading models
-e [tests,fixtures] Skip annotation of fixtures/factories/test files
--exclude
- -n --no-sort Sort by column creation order rather than alphabetical order
+ --sort Sort by alphabetical order rather than column creation order
+
== SORTING
-By default, columns will be sorted alphabetically so that the results of
-annotation are consistent regardless of what order migrations are executed in.
+By default, columns will be sorted in database order (i.e. the order in which migrations were run).
-If you prefer the old behavior, use --no-sort.
+If you prefer to sort alphabetically so that the results of
+annotation are consistent regardless of what order migrations are executed in, use --sort.
== WARNING

0 comments on commit 9ed9a56

Please sign in to comment.