README.rdoc in annotate-sequel-1.0.0.pre2 vs README.rdoc in annotate-sequel-1.0.0.pre3
- old
+ new
@@ -4,37 +4,40 @@
== Example
The schema comment looks like this:
- # == Schema Info
- #
- # Table name: line_items
- #
- # id :integer(11) not null, primary key
- # quantity :integer(11) not null
- # product_id :integer(11) not null
- # unit_price :float
- # order_id :integer(11)
- #
+ # Schema Info
+ #
+ # Table name: items
+ #
+ # id :integer, {:allow_null=>false, :default=>nil, :primary_key=>true, :db_type=>"integer", :ruby_default=>nil}
+ # name :string, {:allow_null=>true, :default=>nil, :primary_key=>false, :db_type=>"varchar(255)", :ruby_default=>nil}
+ # price :float, {:allow_null=>true, :default=>nil, :primary_key=>false, :db_type=>"double precision", :ruby_default=>nil}
+ #
- class LineItem < ActiveRecord::Base
- belongs_to :product
- . . .
+ DB.create_table :items do
+ primary_key :id
+ String :name
+ Float :price
+ end
+ class Item < Sequel::Model(:items)
+ end
+
== Install
For the `Gemfile`
- gem 'annotate-sequel-models'
+ $ gem 'annotate-sequel'
To install on your system
- gem install annotate-sequel-models
+ $ gem install annotate-sequel
== Usage
- rake annotate:sequel
+ $ annotate
== 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.