From 63940c4e42376cbf5cb54962e805d35a79936ebe Mon Sep 17 00:00:00 2001 From: Nuno Job Date: Sat, 20 Aug 2011 17:15:04 +0100 Subject: [PATCH] fixes to readme --- README.md | 8 ++++++-- package.json | 2 +- 2 files changed, 7 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 18f99f69..c63b1504 100644 --- a/README.md +++ b/README.md @@ -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: @@ -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 @@ -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 diff --git a/package.json b/package.json index f7c700dd..06594103 100644 --- a/package.json +++ b/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 (http://nunojob.com)" , "keywords": ["couchdb", "data", "request", "json", "nosql", "micro", "nano"] , "dependencies": {"request": "~2.0.5", "underscore": "~1.1.7"}