README.md

localForage Backbone

Backbone.js driver for the localForage offline storage library.

Install with bower:

bower install localforage-backbone

Run tests with grunt:

grunt test

Submit issues, pull requests, etc. if something is up! <3

Usage

This library lets you override the sync() method on your collections and models so they're saved to localForage instead of a REST server. Simply override your objects' sync() method with the namespace for your model:

    var MyModel = Backbone.Collection.extend({
        sync: Backbone.localforage.sync('MyModel')
    });
    var MyCollection = Backbone.Collection.extend({
        model: MyModel,
        sync: Backbone.localforage.sync('MyCollection')
    });

Now whenever you save your collections or models, they'll be saved with localForage!

License

This program is free software; it is distributed under an Apache License.

---

Copyright (c) 2014 Mozilla (Contributors).