Skip to content
This repository has been archived by the owner on Nov 5, 2018. It is now read-only.

Commit

Permalink
fixes to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
dscape committed Aug 20, 2011
1 parent c6e9ed3 commit 63940c4
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 3 deletions.
8 changes: 6 additions & 2 deletions README.md
Expand Up @@ -13,7 +13,7 @@ a quick example using `nano`

to use `nano` you have to either provide a) a `json` `configuration object` or b) a `configuration file path` like `cfg/tests.js`. refer to [cfg/couch.example.js][4] for a example

var nano = require('nano')('./cfg/tests.js');
var nano = require('nano')('http://localhost:5984');

within the `nano` variable you have various methods you can call. these include tasks like create, delete or list databases:

Expand Down Expand Up @@ -56,6 +56,10 @@ that's it. don't forget to delete the database you created:

nano.db.destroy("alice");

# tutorial

for a small tutorial check out [writings.nunojob.com/2011/08/nano-minimalistic-couchdb-client-for-nodejs.html](http://writings.nunojob.com/2011/08/nano-minimalistic-couchdb-client-for-nodejs.html)

# interfaces

`*` marks optional
Expand Down Expand Up @@ -129,7 +133,7 @@ this is the same as (assuming `alice = nano.use("alice");`):

you can pipe in `nano` just like you do in any other stream. this is available in all methods:

alice.attachment.get("sugar", "att", {rev: rev})
alice.attachment.get("breakfast", "sugar", {rev: rev})
.pipe(fs.createWriteStream("/tmp/sugar-for-rabbit"));

# roadmap
Expand Down
2 changes: 1 addition & 1 deletion package.json
@@ -1,7 +1,7 @@
{ "name": "nano"
, "description": "minimalistic couchdb driver for node.js"
, "homepage": "http://github.com/dscape/nano"
, "version": "0.6.0"
, "version": "0.6.1"
, "author": "Nuno Job <nunojobpinto@gmail.com> (http://nunojob.com)"
, "keywords": ["couchdb", "data", "request", "json", "nosql", "micro", "nano"]
, "dependencies": {"request": "~2.0.5", "underscore": "~1.1.7"}
Expand Down

0 comments on commit 63940c4

Please sign in to comment.