Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Updated readme to show node / npm integration

  • Loading branch information...
commit 25ad5b985ec364d6a18f47e1ef94738af727c32e 1 parent bdbd087
@davidgtonge authored
Showing with 11 additions and 2 deletions.
  1. +11 −2 README.md
View
13 README.md
@@ -1,7 +1,10 @@
backbone-query
===================
-A lightweight (< 3KB minified) utility for Backbone projects.
+.. |travis_status| image:: https://secure.travis-ci.org/davidgtonge/backbone_query.png
+ :target: http://travis-ci.org/davidgtonge/backbone_query
+
+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
[MongoDB](http://www.mongodb.org/display/DOCS/Advanced+Queries)
Please report any bugs, feature requests in the issue tracker.
@@ -10,9 +13,15 @@ Pull requests are welcome!
Usage
=====
+.. 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:
```js
Please sign in to comment.
Something went wrong with that request. Please try again.