Skip to content

Commit

Permalink
[docs] Updating README
Browse files Browse the repository at this point in the history
  • Loading branch information
Marak committed Aug 21, 2012
1 parent 4fb7eaa commit 5d7b107
Showing 1 changed file with 15 additions and 1 deletion.
16 changes: 15 additions & 1 deletion README.md
Expand Up @@ -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:

Expand Down

0 comments on commit 5d7b107

Please sign in to comment.