matrioshka 0.1.1 → 0.1.2

data/README.md

@@ -1,24 +1,46 @@
 # Matrioshka
 
-TODO: Write a gem description
+Organizing redistributable Rails applications can be a pain. Typical way to solve the issue is to write a lot of generators to duplicate entries like migrations, seeds and other stuff from the host application. Modern Rails Engines system however has the ability to proxy all that for you. So most of ready Rails applications can become a gem within few simple steps. 
 
-## Installation
+Matrioshka is a set of ready generators that will do the job on your behalf.
 
-Add this line to your application's Gemfile:
+## Host Application (Gem)
 
-    gem 'matrioshka'
+Inject the following to your host application Gemfile:
 
-And then execute:
+```ruby
+gem 'matrioshka'
+```
 
-    $ bundle
+Run Matrioshka install generator
 
-Or install it yourself as:
+```bash
+rails g matrioshka:install
+```
 
-    $ gem install matrioshka
+It will generate all the required additions and patches. For a typical application they will just work. However you probably should edit `$application.gemspec` to set proper meta information for your future gem.
 
-## Usage
+## Client Application (Consumer)
 
-TODO: Write usage instructions here
+As soon as your gem ready to rumble we can procceed to the consumer. Let's make it work within a new rails application:
+
+```bash
+rails new marakash
+```
+
+Add your application gem to the new Gemfile:
+
+```ruby
+gem '$application'
+```
+
+Run `bundle install` and then 
+
+```bash
+rake $application:link
+```
+
+Ta-dam. You are done here. Time to party hard.
 
 ## Contributing
 

data/lib/matrioshka/version.rb

@@ -1,3 +1,3 @@
 module Matrioshka
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/matrioshka.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |gem|
   gem.email         = ["boris@roundlake.ru"]
   gem.description   = %q{Turn your Rails 3 application into a gem}
   gem.summary       = gem.description
-  gem.homepage      = ""
+  gem.homepage      = "https://github.com/inossidabile/matrioshka"
 
   gem.files         = `git ls-files`.split($/)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: matrioshka
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -33,7 +33,7 @@ files:
 - lib/matrioshka/generator.rb
 - lib/matrioshka/version.rb
 - matrioshka.gemspec
-homepage: ''
+homepage: https://github.com/inossidabile/matrioshka
 licenses: []
 post_install_message: 
 rdoc_options: []