firemodel - npm Package Compare versions

Comparing version 0.2.0 to 0.2.1

bower.json

 {
   "name": "firemodel",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "description": "Data models for Firebase",
@@ -5,0 +5,0 @@ "main": "dist/firemodel.js",

package.json

 {
   "name": "firemodel",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "description": "Data models for Firebase",
@@ -5,0 +5,0 @@ "main": "firemodel.js",

README.md

 # firemodel
-Power Model Support for Firebase
+Powerful Model Support for Firebase
+
+## Getting Started
+
+### node.js Installation
+
+````bash
+npm install --save firebase firemodel
+````
+
+### Setup
+
+````js
+var Firebase = require('firebase');
+var firemodel = require('firemodel');
+
+firemodel(Firebase);
+
+var ref = new Firebase('https://...');
+
+````
+
+### Using a Model
+
+````js
+var Member = ref.model('members');
+````
+
+----------
+
+#### Query API
+
+-----------
+Find (unique filter STRING, field filters ARRAY of STRING)
+````js
+Member.find('kshunz', ['username']);
+Member.results.first();  //--> 'kshunz-admin'
+````
+````js
+Member.find('kshunz');
+Member.results.first();  //--> returns entire {}
+````
+
+
+Setter
+````js
+Member.set('kshunz', { active: true });
+Member.save();
+````
+
+Getter
+````js
+Member.get('kshunz');
+Member.results.first();
+````
+
+---------
+
+#### DAVIE (delete, add, view, index, edit) API
+
+---------
+
+[D]elete
+````js
+Member.delete('kshunz');
+Member.save();
+````
+
+[A]dd
+````js
+Member.add({
+  kshunz: {
+    username: 'kshunz',
+    email: '[e-mail]'
+  }
+});
+
+Member.save();
+````
+
+[V]iew
+````js
+Member.view('kshunz');
+
+var currentMember = Member.results.first();
+````
+
+[I]ndex
+````js
+Member.index();
+Member.results.all(); //returns all members
+````
+
+
+[E]dit
+````js
+Member.edit('kshunz.username', 'kshunz-admin');
+Member.save();
+````

No alert changes

Improved metrics

Total package byte prevSize

15314

increased by8.95%

Number of lines in readme file

101

increased by3266.67%

No dependency changes