data_plan 1.0.1 → 1.0.2

data/README

@@ -5,21 +5,13 @@ 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. 
-After that you can invoke 'rake db:create_migration' and get migrations.
+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.
 
-And then, magic begins. 
-* Add to Rakefile:
-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 find and put all 
+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. 
+That's it, you get migration code automatically. You can migrate 
+immediately, or add some more tweaks to your migration, or something else.
 
 Why is it great? 
 * You have the one place (plan.rb) where you write db schema and 
@@ -29,29 +21,46 @@ 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). 
+name suggested). So you just call 'rake db:create_migration' without
+NAME=... argument and get the migration name for free too.
+
+== How to install
+
+Before use with 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. 
+After that you can invoke 'rake db:create_migration' and get migrations.
+
+* Install the gem: 
+gem install data_plan
+* Add to Rakefile: 
+require 'data_plan/generators/migration/sinatra'
 
 == How to use with Rails
+
+Yes, you can use DataPlan in Rails too. But it better to use not 
+like a gem, and instead directly copy to your application.
+
 Copy from the gem the folder 
-  GEMROOT/lib/data_plan/generators/migration/* 
+  DATAPLANGEMROOT/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' 
 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.
+
+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) 
+were tested.   
 
 == Todo
 
-Indices are partially supported at the moment.
+Indices are partially supported at the moment. But seems they work ;-)
 
 == Changelog
 
@@ -60,12 +69,10 @@ Workaround on views. Thanks to Cyril Boswell.
 == Legal
 
 Found a bug? Fix it and email pull request to me: pavel.vasev@gmail.com
-
 Want to add a feature? Implement it and email the patch!
 
 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

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: data_plan
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 19
   prerelease: 
   segments: 
   - 1
   - 0
-  - 1
-  version: 1.0.1
+  - 2
+  version: 1.0.2
 platform: ruby
 authors: 
 - Pavel Vasev