data_plan 1.0.2 → 1.0.3

data/README

@@ -1,14 +1,15 @@
 == Data Plan
 
-A tool for easy migration generation. Works with Sinatra/ActiveRecord and 
-with Rails too. 
+Data Plan migration generator - computes migration code automatically. 
+Works with Sinatra/ActiveRecord and with Rails too. 
 
 == Usage
 
-Create db/plan.rb file and write desired db schema in it according to
-Rails's schema.rb syntax. Of course, you can update plan.rb anytime later.
+Create db/plan.rb file once and write desired db schema in it according to
+Rails's schema.rb syntax. Tip: in rails, just copy your schema.rb to plan.rb.
+Of course, you can update plan.rb anytime later.
 
-When you create a migration, DataPlan will find and put all 
+When you create a migration, this generator will find and put all 
 differencies between plan.rb and your current database schema!  
 That's it, you get migration code automatically. You can migrate 
 immediately, or add some more tweaks to your migration, or something else.
@@ -24,6 +25,13 @@ Nice bonus: migrations are automatically named (of course you may override
 name suggested). So you just call 'rake db:create_migration' without
 NAME=... argument and get the migration name for free too.
 
+== Example
+./script/generate migration
+
+This will look at plan.rb and at current db. If for example plan.rb contains
+more columns/table/indexes than in db, it will generate migration with 
+corresponding add_column/add_table/add_index commands in it. 
+
 == How to install
 
 Before use with Sinatra, install 'sinatra-activerecord' gem. 
@@ -34,7 +42,7 @@ After that you can invoke 'rake db:create_migration' and get migrations.
 
 * Install the gem: 
 gem install data_plan
-* Add to Rakefile: 
+* Add to Rakefile (after sinatra-activerecord rake commands): 
 require 'data_plan/generators/migration/sinatra'
 
 == How to use with Rails

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: data_plan
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 17
   prerelease: 
   segments: 
   - 1
   - 0
-  - 2
-  version: 1.0.2
+  - 3
+  version: 1.0.3
 platform: ruby
 authors: 
 - Pavel Vasev
@@ -69,6 +69,6 @@ rubyforge_project:
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: Sinatra/ActiveRecord tool for easy migration generation. Works with Rails too.
+summary: Data Plan migration generator - computes migration code automatically. Works with Sinatra/ActiveRecord and with Rails too.
 test_files: []