Skip to content
Browse files

Updated readme to show node / npm integration

  • Loading branch information...
1 parent bdbd087 commit 25ad5b985ec364d6a18f47e1ef94738af727c32e @davidgtonge committed
Showing with 11 additions and 2 deletions.
  1. +11 −2
@@ -1,7 +1,10 @@
-A lightweight (< 3KB minified) utility for Backbone projects.
+.. |travis_status| image::
+ :target:
+A lightweight (3KB minified) utility for Backbone projects, that works in the Browser and on the Server.
Adds the ability to search for models with a Query API similar to
Please report any bugs, feature requests in the issue tracker.
@@ -10,9 +13,15 @@ Pull requests are welcome!
+.. Client Side Installation:
To install, include the `js/backbone-query.min.js` file in your HTML page, after Backbone and it's dependencies.
Then extend your collections from Backbone.QueryCollection rather than from Backbone.Collection.
+.. Server side (node.js) installation
+You can install with NPM: `npm install backbone-query`
+Then simply require in your project: `QueryCollection = require("backbone-query").QueryCollection`
Your collections will now have a `query` method that can be used like this:

0 comments on commit 25ad5b9

Please sign in to comment.
Something went wrong with that request. Please try again.