Skip to content

Commit 9ed9a56

Browse files
committed
update readme
1 parent 4bc5397 commit 9ed9a56

File tree

1 file changed

+19
-14
lines changed

1 file changed

+19
-14
lines changed

README.rdoc

Lines changed: 19 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -41,20 +41,24 @@ Also, if you pass the -r option, it'll annotate routes.rb with the output of "ra
4141

4242
== INSTALL
4343

44+
Into Gemfile from rubygems.org:
45+
46+
gem 'annotate', ">=2.5.0.pre1"
47+
4448
Into Gemfile from Github:
4549

46-
gem 'annotate', :git => 'git://github.com/MrJoy/annotate_models.git'
50+
gem 'annotate', :git => 'git://github.com/ctran/annotate_models.git'
4751

4852
Into environment gems From rubygems.org:
4953

5054
gem install annotate
5155

5256
Into environment gems from Github checkout:
5357

54-
git clone git://github.com/MrJoy/annotate_models.git annotate_models
55-
cd annotate_models
56-
rake build
57-
gem install pkg/annotate-*.gem
58+
git clone git://github.com/ctran/annotate_models.git annotate_models
59+
cd annotate_models
60+
rake build
61+
gem install pkg/annotate-*.gem
5862

5963
== USAGE
6064

@@ -63,23 +67,23 @@ Into environment gems from Github checkout:
6367
To annotate all your models, tests, fixtures, etc.:
6468

6569
cd /path/to/app
66-
annotate_models
70+
annotate
6771

6872
To annotate your models and tests:
6973

70-
annotate_models --exclude fixtures
74+
annotate --exclude fixtures
7175

7276
To annotate just your models:
7377

74-
annotate_models --exclude tests,fixtures
78+
annotate --exclude tests,fixtures
7579

7680
To annotate routes.rb:
7781

78-
annotate_models -r
82+
annotate -r
7983

8084
To remove annotations:
8185

82-
annotate_models -d
86+
annotate -d
8387

8488
To automatically annotate after running 'rake db:migrate', ensure you've added
8589
annotate_models to your Rails project's Gemfile, and run this:
@@ -110,14 +114,15 @@ anywhere in the file:
110114
-R, --require path Additional files to require before loading models
111115
-e [tests,fixtures] Skip annotation of fixtures/factories/test files
112116
--exclude
113-
-n --no-sort Sort by column creation order rather than alphabetical order
117+
--sort Sort by alphabetical order rather than column creation order
118+
114119

115120
== SORTING
116121

117-
By default, columns will be sorted alphabetically so that the results of
118-
annotation are consistent regardless of what order migrations are executed in.
122+
By default, columns will be sorted in database order (i.e. the order in which migrations were run).
119123

120-
If you prefer the old behavior, use --no-sort.
124+
If you prefer to sort alphabetically so that the results of
125+
annotation are consistent regardless of what order migrations are executed in, use --sort.
121126

122127
== WARNING
123128

0 commit comments

Comments
 (0)