README.md in ember_script-rails-0.0.1 vs README.md in ember_script-rails-0.0.2
- old
+ new
@@ -1,19 +1,33 @@
-= ember-script-rails
+# EmberScript-Rails
-Description goes here.
+Provides integration with Rail's asset pipeline. Any javascript files with the extension `.em` will automatically be compiled by [EmberScript](https://github.com/ghempton/ember-script).
-== Contributing to ember-script-rails
+## Installation
+
+This gem requires that an `ember-script` command be available in the current path. Being as EmberScript is still in early development, it is best to install via npm from git. After installing [Node.js](http://nodejs.org/), run the following command:
+
+```
+sudo npm install -g 'git://github.com/ghempton/ember-script.git#HEAD'
+```
+
+After installation, add the following to your Gemfile:
+
+```
+gem 'ember_script-rails'
+```
+
+## Contributing to ember-script-rails
* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
* Fork the project.
* Start a feature/bugfix branch.
* Commit and push until you are happy with your contribution.
* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
-== Copyright
+## Copyright
Copyright (c) 2012 Gordon L. Hempton. See LICENSE.txt for
further details.