Skip to content

Commit

Permalink
Updated to link to performance pic
Browse files Browse the repository at this point in the history
  • Loading branch information
dhruvaray committed Aug 24, 2012
1 parent a032d5d commit d90deed
Showing 1 changed file with 4 additions and 9 deletions.
13 changes: 4 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,16 @@
# Backbone-associations
Backbone-associations was born out of a need to provide a lightweight implementation of [Backbone-relational](https://github.com/PaulUithol/Backbone-relational/) with a limited, but commonly used feature subset. We support one-to-one and one-to-many relations between Backbone.Models. This implementation offers speed and a low memory footprint for models having these relation types. It is able to handle updates to nested models in a performing fashion. See [benchmarks and tests](https://raw.github.com/dhruvaray/backbone-associations/master/test/test-suite.html) for detailed results.
Backbone-associations was born out of a need to provide a lightweight implementation of [Backbone-relational](https://github.com/PaulUithol/Backbone-relational/) with a limited, but commonly used feature subset. We support one-to-one and one-to-many relations between Backbone.Models. This implementation offers speed and a low memory footprint for models having these relation types. It is able to handle updates to nested models in a performing fashion.

![Performance](https://raw.github.com/dhruvaray/backbone-associations/master/test/speed.png)


## Contents

* [Download](#download)
* [Installation](#installation)
* [Specifying Associations](#associations)
* [Eventing with Associations](#eventing)
* [Known Issues](#issues)

### <a name="download"/>Download
You can download the latest

* [Development Version 0.1](https://raw.github.com/dhruvaray/backbone-associations/master/backbone-associations.js)
* [Production Version 0.1](https://raw.github.com/dhruvaray/backbone-associations/master/backbone-associations-min.js)

### <a name="installation"/>Installation

Backbone-associations depends on [backbone](https://github.com/documentcloud/backbone) (and thus on [underscore](https://github.com/documentcloud/underscore)). Include Backbone-relational right after Backbone and Underscore:
Expand Down Expand Up @@ -102,7 +97,7 @@ Used for specifying one-to-one or one-to-many relationships.
A string (which can be resolved to an object type on the global scope), or a reference to a `Backbone.Collection` type. Determine the type of collections used for a `Many` relation.

## <a name="eventing"/>Eventing with `AssociatedModels`
CRUD operations on AssociatedModels trigger the appropriate events - identical to base Backbone Models & Collections. This is best understood with a simple example. More detailed examples can be found in the [test suite](https://raw.github.com/dhruvaray/backbone-associations/master/test/test-suite.html).
CRUD operations on AssociatedModels trigger the appropriate events - identical to base Backbone Models & Collections. This is best understood with a simple example. More detailed examples can be found in the test suite.


````javascript
Expand Down

0 comments on commit d90deed

Please sign in to comment.