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

Commit

Permalink
Minor changes to docs to make things easier to read
Browse files Browse the repository at this point in the history
  • Loading branch information
dscape committed Aug 15, 2011
1 parent 630d91a commit 4de57cc
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
4 changes: 2 additions & 2 deletions README.md
@@ -1,6 +1,6 @@
# Nano

`nano` (short for NanoCouch) is a minimalistic CouchDB driver for Node.js.
`nano` (short for NanoCouch) is a minimalistic `couchdb` driver for `node.js`.

## Instalation

Expand All @@ -17,7 +17,7 @@ In `nano` callback always return three arguments:
headers: The HTTP response headers from CouchDB, if no error.
response: The HTTP response body from CouchDB, if no error.

Because in `nano` you can do database operations you are not bound to one and only one database. The first thing you do is load the module pointing either providing a JSON configuration object or a string that represents the relative file path of that config, e.g. `cfg/tests.js`. Do refer to [cfg/couch.example.js][4] for a sample.
Because in `nano` you can do database operations you are not bound to one and only one database. The first thing you do is load the module pointing either providing a JSON configuration object or a string that represents the relative file path of that config, e.g. `cfg/tests.js`. Do refer to [cfg/couch.example.js][4] for a example. There you can use it to specify where `couchdb` lives, if you want to use `https`, or even to use a `proxy`.

var nano = require('nano')('./cfg/tests.js');

Expand Down
4 changes: 2 additions & 2 deletions nano.js
Expand Up @@ -32,9 +32,9 @@ var request = require('request')
* - It is not meant to prevent you from doing stupid things.
* Be creative. Be silly. Do stupid things. I won't thow exceptions back at you.
*
* Have fun! Relax, and don't forget to take the trash out. (compact)
* Have fun! Relax, and don't forget to compact.
* Dinosaurs spaceships ftw!
*/

module.exports = exports = nano = function database_module(cfg) {
var public_functions = {};
if(typeof cfg === "string") {
Expand Down

0 comments on commit 4de57cc

Please sign in to comment.