README.md in simplate-0.1.0 vs README.md in simplate-0.1.1
- old
+ new
@@ -1,9 +1,27 @@
# Simplate
-TODO: Write a gem description
+[![Code Climate](https://codeclimate.com/github/serv/simplate.png)](https://codeclimate.com/github/serv/simplate)
+![](http://i.imgur.com/vJZuDoI.jpg)
+
+Simplate generates a perfect directory structure
+for a well organized Ruby app.
+
+```
+├── Gemfile
+├── lib
+│ ├── models
+│ └── modules
+└── spec
+ ├── models
+ ├── modules
+ └── spec_helper.rb
+```
+
+Simplate uses [RSpec](http://rspec.info/) as the default test suite.
+
## Installation
Add this line to your application's Gemfile:
gem 'simplate'
@@ -16,10 +34,14 @@
$ gem install simplate
## Usage
-TODO: Write usage instructions here
+1. Install `simplate` gem.
+2. Open Terminal
+3. Go to the directory where you want to generate the *simplate*
+boilerplate
+4. Run `$ simplate some_app_name`
## Contributing
1. Fork it ( http://github.com/<my-github-username>/simplate/fork )
2. Create your feature branch (`git checkout -b my-new-feature`)