Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Merge remote-tracking branch 'upstream/master'

  • Loading branch information...
commit 95777fe50f04aa2ade3eb5a3add730eb04ec3698 2 parents 64b8696 + ff957d1
@chbm authored
Showing with 18 additions and 11 deletions.
  1. +18 −11 README.md
View
29 README.md
@@ -1,7 +1,16 @@
<img src="https://github.com/flatiron/resourceful/raw/master/resourceful.png" />
# Synopsis
-Isomorphic Resource engine for JavaScript. Resources are business logic wrapped in prototypical models with schema and validation. Supports several data-providers such as: Memory, CouchDB, MongoDB, REST, socket.io, and File-System.
+
+ - Isomorphic Resource engine for JavaScript
+ - Resources are business logic wrapped in prototypical models with schema and validation
+ - Resources support several data-providers
+ - Memory
+ - File-System
+ - CouchDB
+ - MongoDB
+ - REST
+ - socket.io
# Status
@@ -64,16 +73,6 @@ Creature.prototype.feed = function (food) {
* [Engine Constructor](https://github.com/flatiron/resourceful/wiki/Engine-Constructor)
* [Engine Caching](https://github.com/flatiron/resourceful/wiki/Engine-Caching)
-<a name="relationships"></a>
-# Relational Resources
-
-Resourceful supports a simple `Resource.parent` API, which is actually quite robust. Through this API, resourceful supports one-one, one-many, and many-many relationships.
-
-### Documentation
-
- * [Relational Resources](https://github.com/flatiron/resourceful/wiki/Relational-Resources)
-
-
# API
## Resource Constructor Methods
@@ -108,6 +107,14 @@ These methods are available on all user-defined resource constructors which are
* `Parent.prototype.createChild(properties, [callback])`
* `Child.prototype.parent([callback])`: Fetches the parent of the given child instance.
+<a name="relationships"></a>
+# Relational Resources
+
+Resourceful supports a simple `Resource.parent` API, supports one-one, one-many, and many-many relationships.
+
+### Documentation
+
+ * [Relational Resources](https://github.com/flatiron/resourceful/wiki/Relational-Resources)
# Tests
All tests are written with [vows][0] and should be run with [npm][1]:
Please sign in to comment.
Something went wrong with that request. Please try again.