README.md in opal-erb-0.0.2 vs README.md in opal-erb-0.1.0
- old
+ new
@@ -1,14 +1,42 @@
# opal-erb: ERB for Opal
+Provides an ERB compiler and runtime for opal.
+
+## Installation
+
+Add to your Gemfile:
+
+```ruby
+gem 'opal-erb'
+```
+
+Then require anywhere in your code:
+
+```ruby
+require 'opal-gem' # if you don't Bundler.require
+```
+
## Usage
-opal-erb will automatically compile erb files using the `.opalerb` extension.
+This gem adds support to sprockets to compile files with `.opalerb` extensions
+automatically, so, if you have:
-## Running specs
+```erb
+<!-- my_template.opalerb -->
+Hello <%= @name %>!
+```
-You must have phantomjs installed.
+```ruby
+# my_app.rb
-```text
-$ bundle
-$ bundle exec rake
+require "my_template"
+
+@name = 'Adam'
+
+Template["my_template"].render self
+# => "Hello Adam!"
```
+
+## License
+
+MIT