README.rdoc in annotate-sequel-1.0.0.final vs README.rdoc in annotate-sequel-1.0.0.pre1

- old
+ new

@@ -1,52 +1,40 @@ = annotate-sequel A gem to annotate your Sequel models. -== DISCLAIMER: Not ready for production, yet - -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 - # - # 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} - # + # == 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) + # - DB.create_table :items do - primary_key :id - String :name - Float :price - end + class LineItem < ActiveRecord::Base + belongs_to :product + . . . - class Item < Sequel::Model(:items) - end - == Install For the `Gemfile` - $ gem 'annotate-sequel' + gem 'annotate-sequel-models' -== Usage +To install on your system -In your Rails project run: + gem install annotate-sequel-models - $ annotate +== Usage -That's it. - -== TODO - -* Update models after migrations + rake annotate:sequel == 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.