Update README and TODO with object aliases

dm77 · Apr 14, 2011 · 08f7666 · 08f7666
1 parent 0f15967
commit 08f7666
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -43,7 +43,12 @@ To declare the data object for use in the template:
      # app/views/users/show.json.rabl
      object @user
 
-or a collection works:
+or specify an alias for the object:
+
+    object @user => :person
+    # { "person" : { ... } }
+
+or pass a collection:
 
      object @users
 
@@ -154,7 +159,6 @@ Using partials and inheritance can significantly reduce code duplication in your
 
 Check out the [Issues](https://github.com/nesquena/rabl/issues) tab for a full list:
 
- * I am sloppy and failed to unit test this as I cobbled it together. Don't use it in production until I do, for now this is a fun experiment.
  * No configuration options yet for how to create the json (root nodes) :(
  * Better Tilt template support (precompiling templates)
  * Benchmarks and performance optimizations

diff --git a/TODO b/TODO
@@ -1,7 +1,7 @@
 = TODO
 
+ - Add support for @users => :people creates { "people" : [{ ... }] }
  - Test the code, child and glue options
  - Add support for child collection with "root" for each
  - Child should support collections of children
- - Child should support symbol associations inside object
- - Add support for Rails 3
+ - Child should support symbol associations inside object