teacup-rails 0.0.1 → 0.0.2

data/README.md

@@ -1,6 +1,9 @@
+![teacup](https://raw.github.com/goodeggs/teacup/master/docs/teacup.jpg)
+
 # Teacup::Rails
 
-TODO: Write a gem description
+Teacup::Rails makes [Teacup](http://goodeggs.github.com/teacup) native CoffeeScript templates
+available to the Rails asset pipeline.
 
 ## Installation
 
@@ -16,9 +19,49 @@ Or install it yourself as:
 
     $ gem install teacup-rails
 
+Make Teacup available to your JavaScript application by requiring it in `app/assets/javascripts/application.js`
+before your application files.
+
+``` javascript
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+
+//= require jquery
+//= require jquery_ujs
+//= require teacup
+//= require_tree .
+```
+
 ## Usage
 
-TODO: Write usage instructions here
+Teacup exports one reference to the global scope as `window.teacup`. Import the tags you need to render your view.
+
+```coffeescript
+{renderable, h1, table, tr, th, td, a} = teacup
+template = renderable ({posts})->
+  h1 'Listing posts'
+  table "#posts-table", ->
+    tr ->
+      th 'Title'
+      th 'Content'
+    for post in posts
+      tr '.post-row', ->
+        td post.title
+        td post.content
+  a href: '#/new', 'New Post'
+
+class IndexView extends Backbone.View
+  template: template
+
+  constructor: ({@posts}) ->
+    super()
+
+  render: =>
+    @$el.html @template(posts: @posts.toJSON())
+    @
+```
+
+See [Teacup Examples](http://goodeggs.github.com/teacup/#examples) for more usage examples.
 
 ## Contributing
 

data/lib/teacup-rails.rb

@@ -1,7 +1,9 @@
+require 'rails'
 require "teacup-rails/version"
 
 module Teacup
   module Rails
-    # Your code goes here...
+    class Engine < ::Rails::Engine
+    end
   end
 end

data/lib/teacup-rails/version.rb

@@ -1,5 +1,5 @@
 module Teacup
   module Rails
-    VERSION = "0.0.1"
+    VERSION = "0.0.2"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: teacup-rails
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors: