Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

added installation notes

  • Loading branch information...
commit 2c17b57795e342f654656d0221e20132f7a79507 1 parent e1b3321
@caolan caolan authored
Showing with 18 additions and 0 deletions.
  1. +18 −0 README.md
View
18 README.md
@@ -4,6 +4,24 @@ This contains the core functions for dealing with CouchDB. That includes
document CRUD operations, querying views and creating/deleting databases.
+### Installation
+
+Add `db` to your dependencies section in `kanso.json`.
+
+```javascript
+ ...
+ "dependencies": {
+ "db": null,
+ ...
+ }
+```
+
+> run `kanso install` to fetch the package
+
+You also need __jQuery__ to be included on your page, since this module uses
+jQuery.ajax to make requests.
+
+
### Events
The db module is an EventEmitter. See the
Please sign in to comment.
Something went wrong with that request. Please try again.