README.rdoc in annotate-sequel-1.0.0.pre3 vs README.rdoc in annotate-sequel-1.0.0
- old
+ new
@@ -1,9 +1,12 @@
= annotate-sequel
A gem to annotate your Sequel models.
+Currently only tested for Rails 3 and only supports Sequel 3.x as of right now.
+Eventually this gem will support Sequel 4.
+
== Example
The schema comment looks like this:
# Schema Info
@@ -28,16 +31,20 @@
For the `Gemfile`
$ gem 'annotate-sequel'
-To install on your system
-
- $ gem install annotate-sequel
-
== Usage
+In your Rails project run:
+
$ annotate
+
+That's it.
+
+== TODO
+
+* Update models after migrations
== Contributing to annotate-sequel
* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.