Skip to content

Commit 2a2290e

Browse files
committed
documentation updates
1 parent 9470e25 commit 2a2290e

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ A plugin to make [Backbone.js](http://documentcloud.github.com/backbone) keep tr
44

55
## The Need
66

7-
Suppose you have a Backbone Model with nested attributes. Updating the nested attribute won't cause the model's `"change"` event to fire, which is confusing.
7+
Suppose you have a Backbone Model with nested attributes, perhaps to remain consistent with your document-oriented database. Updating the nested attribute won't cause the model's `"change"` event to fire, which is confusing.
88

99
```javascript
1010
var user = new Backbone.Model({
@@ -30,7 +30,7 @@ user.bind('change:name.first', function(){ ... });
3030

3131
## Usage
3232

33-
1. Download the [latest version](https://github.com/afeld/backbone-nested/downloads), and add `backbone-nested.js` to your HTML `<head>`, **after** `backbone.js` is included.
33+
1. Download the [latest version](https://github.com/afeld/backbone-nested/downloads), and add `backbone-nested.js` to your HTML `<head>`, **after** `backbone.js` is included (tested against Backbone v0.5.3).
3434

3535
```html
3636
<script type="text/javascript" src="backbone.js"></script>
@@ -57,7 +57,7 @@ user.bind('change:name.first', function(){ ... });
5757
user.set({'name.first': 'Bob'});
5858
```
5959

60-
Best of all, `Backbone.NestedModel` is designed to be a drop-in replacement of `Backbone.Model`, so the switch can be made gradually. See [here](https://github.com/afeld/backbone-nested/issues?labels=Parity) for any known feature-parity issues.
60+
Best of all, `Backbone.NestedModel` is designed to be a [backwards-compatible](http://afeld.github.com/backbone-nested/test/), drop-in replacement of `Backbone.Model`, so the switch can be made painlessly.
6161

6262
## Nested Attributes
6363

0 commit comments

Comments
 (0)