Updating documentation.

History.txt

+== HEAD
+
+* Add sorting for columns and indexes. (Helpful for out-of-order migration execution!)
+* BugFix for models without tables.
+* Annotate unit tests in subfolders.
+* Add generator to install rakefile that automatically annotates on db:migrate.
+* Fix gemspec generation now that Jeweler looks at Gemfile.
+* Correct Gemfile to clarify which environments need which gems.
+* Add an .rvmrc to facilitate clean development.
+* Refactor out ActiveRecord monkey-patch to permit extending without side-effects.
+* Use ObjectSpace to locate models to facilitate handling of models with non-standard capitalization.
+  Note that this still requires that the inflector be configured to understand the special case.
+* Merge away a few branches whose changes we already have in order to clean up the Github network graph.
+* Fix warning: `NOTE: Gem::Specification#default_executable= is deprecated with no replacement. It will be removed on or after 2011-10-01.`
+
 == 2.1 2009-10-18
 
 * New options

README.rdoc

@@ -75,28 +75,14 @@ To annotate routes.rb:
 
   annotate -r
 
-To automatically annotate after running 'rake db:migrate':
+To automatically annotate after running 'rake db:migrate', ensure you've added
+annotate_models to your Rails project's Gemfile, and run this:
 
-  [*needs more clarity*] unpack the gem into vendor/plugins, or maybe vendor/gems, or maybe just require tasks/migrate.rake.
+  rails g annotate_models:install
 
-If you install annotate_models as a plugin, it will automatically
-adjust your <tt>rake db:migrate</tt> tasks so that they update the
-annotations in your model files for you once the migration is
-completed. To get the same behavior from a gem, add the following to
-your Rakefile:
-
-  require 'annotate/tasks'
-
-To customize the behavior of annotate when it is running as a Rake
-task, use the following (in your Rakefile or wherever):
-
-  ENV['position_in_class']   = "before"
-  ENV['position_in_fixture'] = "before"
-  ENV['show_indexes']        = "false"
-  ENV['include_version']     = "false"
-  ENV['exclude_tests']       = "false"
-  ENV['exclude_fixtures']    = "false"
-  ENV['skip_on_db_migrate']  = "false"
+This will produce a .rake file that will ensure annotation happens after
+migration (but only in development mode), and provide configuration options
+you can use to tailor the output.
 
 == OPTIONS
 
@@ -141,6 +127,7 @@ Original code by: Dave Thomas -- Pragmatic Programmers, LLC
 Overhauled by: Alex Chaffee
 Gemmed by: Cuong Tran
 Maintained by: Alex Chaffee and Cuong Tran
+Integration by: Jon Frisby
 
 Modifications by:
 
@@ -158,5 +145,6 @@ Modifications by:
  - Gavin Montague - http://github.com/govan/
  - Alexander Semyonov - http://github.com/rotuka/
  - Ian Duggan http://github.com/ijcd/
+ - Jon Frisby http://github.com/mrjoy/
 
 and many others that I may have missed to add.