backbone-idb - npm Package Compare versions

Comparing version 0.2.4 to 0.2.5

backbone-idb.js

 /**
  * @license
  * Backbone IndexedDB Adapter
- * Version 0.2.4
+ * Version 0.2.5
  * Copyright (c) 2013-2014 Vincent Mac
@@ -52,4 +52,4 @@ *
       
-      // By default, make the Backbone.IndexedDB available through `parent.idbStore`
-      that.parent.idbStore = that;
+      // By default, make the Backbone.IndexedDB available through `parent.indexedDB`
+      // that.parent.indexedDB = that;
       // Fire ready event on parent model or collection
@@ -84,3 +84,3 @@ that.parent.trigger('idb:ready', that);
      */
-    version: '0.2.4',
+    version: '0.2.5',
 
@@ -87,0 +87,0 @@ /**

bower.json

 {
   "name": "backbone-idb",
-  "version": "0.2.4",
+  "version": "0.2.5",
   "description": "Backbone IndexedDB adapter with cross browser support via IDBWrapper",
@@ -5,0 +5,0 @@ "license": "MIT",

package.json

 {
   "name": "backbone-idb",
-  "version": "0.2.4",
+  "version": "0.2.5",
   "description": "Backbone IndexedDB adapter with cross browser support via IDBWrapper",
@@ -5,0 +5,0 @@ "license": "MIT",

README.md

 backbone-idb
 ============
 
-Backbone IndexedDB adapter with cross browser support via IDBWrapper
+Backbone [IndexedDB](https://developer.mozilla.org/en-US/docs/IndexedDB) adapter with cross browser support via [IDBWrapper](https://github.com/jensarps/IDBWrapper)
 
@@ -17,2 +17,29 @@ <!-- [![browser support](http://ci.testling.com/vincentmac/backbone-idb.png)](http://ci.testling.com/vincentmac/backbone-idb) -->
 
+## Dependencies
+- [Backbone](https://github.com/jashkenas/backbone)
+- [LoDash](https://github.com/lodash/lodash) (or [Underscore](https://github.com/jashkenas/underscore/))
+- [IDBWrapper](https://github.com/jensarps/IDBWrapper)
+
+## Obtaining backbone-idb
+
+Available via `npm`
+
+```Shell
+$ npm install backbone-idb
+# or
+$ npm install backbone-idb --save # to install and save to package.json
+```
+
+Also available via `bower`
+```Shell
+$ bower install backbone-idb
+# or
+$ bower install backbone-idb --save # to install and save to bower.json
+```
+
+## Usage
+
+Define a `Backbone.Model` or `Backbone.Collection` with an `indexedDB` property in the initialize function.
+
+
 ```JavaScript
@@ -38,6 +65,54 @@ var Note = Backbone.Model.extend({});
 
-  idbStore: null,
-
   model: Note
 });
 ```
+
+The first parameter passed into Backbone.IndexedDB is the `options` object.  You may pass in an empty object and have the default attributes set for the store (defaults listed below).  Any options that you pass in will override the defaults.
+```JavaScript
+// The default options object set on the Collection/Model
+var options = {
+  storeName: 'Store',
+  storePrefix: '',
+  dbVersion: 1,
+  keyPath: 'id',
+  autoIncrement: true,
+  onStoreReady: defaultReadyHandler,
+  onError: defaultErrorHandler,
+  indexes: []
+};
+```
+
+Since [indexedDB is asynchronous](https://developer.mozilla.org/en-US/docs/IndexedDB) in nature, we need to update the way we instantiate a new Collection or Model.  By default, backbone-idb will trigger `idb:ready` on the object.  This behaviour can be overridden by setting your own callback function on the `onStoreReady` attribute in the options object.
+
+
+```JavaScript
+var notes = new Notes();
+
+notes.once('idb:ready', function() {
+  // Some actions to take after initializing the new collection
+});
+```
+
+Collections/Models can now use the same Backbone.sync api to interact with IndexedDB; however, you will need to add your own success callback and, optionally, your own error callback in the options parameter.
+
+```JavaScript
+notes.fetch({success: function() {
+  // fetch success handler
+}});
+
+var note = new Note();
+
+notes.add(note);
+note.save({title: 'some note title'}, {success: function() {
+  // save success handler
+}});
+```
+
+### TODO
+
+- Document retrieving models from a store by an `index` via the `iterate` command
+- Document keyRanges
+- Proxying directly to `idb-wrapper` via the `indexedDB.store` object
+
+
+

No alert changes

Improved metrics

Total package byte prevSize

18804

14.55%

Number of lines in readme file

117

178.57%

No dependency changes