data_plan 1.0.0 → 1.0.1

data/README

@@ -1,12 +1,14 @@
 == Data Plan
 
-A tool for easy migration generation. Works with Sinatra/ActiveRecord and with Rails too.
+A tool for easy migration generation. Works with Sinatra/ActiveRecord and 
+with Rails too. 
 
 == Usage
 
 Before use in Sinatra, install 'sinatra-activerecord' gem. 
-It extends Sinatra with extension methods and Rake tasks for dealing with an SQL database using the ActiveRecord ORM.
-Follow it's instructions and create a Rakefile with migration commands.
+It extends Sinatra with extension methods and Rake tasks for dealing with  
+an SQL database using the ActiveRecord ORM. 
+Follow it's instructions and create a Rakefile with migration commands. 
 After that you can invoke 'rake db:create_migration' and get migrations.
 
 And then, magic begins. 
@@ -14,27 +16,39 @@ And then, magic begins.
 require 'data_plan/generators/migration/sinatra'
 * Create db/plan.rb file and describe desired db schema in it.
 
-Now, when you create a migration, DataPlan will generate a new migration and put all differencies 
-between plan.rb and your current database schema! You can migrate immediately, or add some
-more tweaks to your migration, or something else.
+Now, when you create a migration, DataPlan will find and put all 
+differencies between plan.rb and your current database schema!  
+That's it, you get migration code for free. You can migrate immediately, 
+or add some more tweaks to your migration, or something else. 
 
-Why is it great? Because you don't need to remember all that syntax like
-change_column, add_column, etc - you just modify your schema (in the plan.rb).
+Why is it great? 
+* You have the one place (plan.rb) where you write db schema and 
+comments on it.
+* You don't need to remember all that syntax like
+change_column, add_column, etc. You just write the schema in plan.rb 
+file and get migrations code for free.
 
-Nice bonus: migrations are automatically named (of course you may override name suggested).
+Nice bonus: migrations are automatically named (of course you may override 
+name suggested). 
 
 == How to use with Rails
 Copy from the gem the folder 
-GEMROOT/lib/data_plan/generators/migration/* 
+  GEMROOT/lib/data_plan/generators/migration/* 
 to the Rails project as follows:
-YOURAPPROOT/lib/generators/migration/*
-Thats it, Data Plan now in your rails app, and you can invoke 'script/generate migration' 
+  YOURAPPROOT/lib/generators/migration/*
+Thats it, Data Plan now in your rails app, 
+and you can invoke 'script/generate migration' 
 and get migrations auto-generated as described above.
 
 == How to install
 
 gem install data_plan
 
+== Ruby versions
+Because Sinatra-ActiveRecord works only with Ruby 1.9, DataPlan works with 1.9 for Sinatra.
+For Rails, it should work both for 1.8 and 1.9.
+Only (Sinatra-ActiveRecord 1.1.2 + ruby 1.9) and (Rails 2.3 + ruby 1.8) was tested.
+
 == Todo
 
 Indices are partially supported at the moment.
@@ -54,4 +68,4 @@ Pavel Vasev [ pavel.vasev@gmail.com ]
 
 Released under the MIT license (included)
 
-p.s. Schema-Definition plugin is hugely based on Auto-Migrations by PJ Hyett [ pjhyett@gmail.com ]
+p.s. Schema-Definition plugin is hugely based on Auto-Migrations by PJ Hyett

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: data_plan
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 21
   prerelease: 
   segments: 
   - 1
   - 0
-  - 0
-  version: 1.0.0
+  - 1
+  version: 1.0.1
 platform: ruby
 authors: 
 - Pavel Vasev
@@ -38,8 +38,8 @@ files:
 - LICENSE
 - test/test_data_plan.rb
 homepage: http://rubygems.org/gems/data_plan
-licenses: []
-
+licenses: 
+- MIT
 post_install_message: 
 rdoc_options: []