Permalink
Browse files

[docs] Updating README

  • Loading branch information...
1 parent 4fb7eaa commit 5d7b107ce4fbee54d29a6d7f8f369f79d275788b @Marak Marak committed Aug 21, 2012
Showing with 15 additions and 1 deletion.
  1. +15 −1 README.md
View
@@ -18,7 +18,21 @@ Through the removal of this boilerplate code, restful creates a robust, standard
# Usage
-## As a Flatiron Plugin
+## Define resource(s)
+
+```js
+
+var resourceful = require('resourceful'),
+ Creature = resourceful.define('creature');
+
+Creature.property('type', String, { default: "dragon" });
+Creature.property('life', Number, { default: 10, min: 0, max: 20 });
+
+```
+
+*[additional API documentation for defining resources](http://github.com/flatiron/resourceful)*
+
+## As a Flatiron plugin
To use restful as a <a href="http://github.com/flatiron/flatiron">Flatiron</a> plugin you will have to:

0 comments on commit 5d7b107

Please sign in to comment.