README.md in ahnnotate-0.2.0 vs README.md in ahnnotate-0.3.0

- old
+ new

@@ -1,15 +1,16 @@ # Ahnnotate -Ahnnotate comments on your ActiveRecord models with their respective schemas! +[Ahnnotate][rubygem] comments on your ActiveRecord models with their respective +schemas! Ahnnotate performs static analysis on your files to determine which files should be annotated. The primary goals of ahnnotate are ease of configuration and correctness. It's very similar to [annotate][annotate] and was inspired heavily by it. -Annotate has more features than ahnnotate does; it may fit your needs much +Annotate has more features than ahnnotate does; it may fit your needs a bit better. ## Installation @@ -28,12 +29,11 @@ ## Usage Please use source control management software like git, mercurial, etc! The purpose of this software is to overwrite your source files. Although I'm pretty -comfortable running this in my own projects, I've definitely made a couple bugs -in my lifetime! +comfortable running this, I've definitely made a couple bugs in my lifetime! ### In a Rails app To run it manually, run: @@ -43,11 +43,12 @@ # OR bundle exec rake ahnnotate ``` (Leaving out the `--fix` argument runs the command but doesn't make any changes -to your filesystem. The rake task assumes that you do want to fix by default.) +to your filesystem. However, the rake task assumes that you do want to fix by +default.) Ahnnotate automatically runs after running migrations. This can be disabled, though by creating a `.ahnnotate.yml` configuration file and setting `rake_db_autorun: false`. @@ -114,5 +115,6 @@ [annotate]: https://github.com/ctran/annotate_models [github]: https://github.com/zachahn/ahnnotate [mit]: https://opensource.org/licenses/MIT +[rubygem]: https://rubygems.org/gems/ahnnotate