README.md in modularity-rails-0.1.0 vs README.md in modularity-rails-0.2.0
- old
+ new
@@ -1,25 +1,39 @@
-# Modularity::Rails
+# Modularity::Rails [![Build Status](https://secure.travis-ci.org/kevgo/modularity-rails.png)](http://travis-ci.org/#!/kevgo/modularity-rails)
-TODO: Write a gem description
+Makes the [Modularity CoffeeScript](http://github.com/kevgo/modularity-coffeescript) library available to
+Rails 3.1 applications.
+
## Installation
Add this line to your application's Gemfile:
+
+```ruby
+gem 'modularity-rails'
+```
- gem 'modularity-rails'
-
And then execute:
- $ bundle
+```bash
+$ bundle
+```
-Or install it yourself as:
+Finally, you have to load the modularity file into your application's javascript.
+The easiest way is to add it to `application.js`:
- $ gem install modularity-rails
+```javascript
+/**
+ *= require jquery
+ *= require modularity
+ */
+```
+
## Usage
-TODO: Write usage instructions here
+See [http://github.com/kevgo/modularity-coffeescript].
+
## Contributing
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)