couchdb-client
Advanced tools
Comparing version 1.0.4 to 1.0.5
{ | ||
"name": "couchdb-client", | ||
"version": "1.0.4", | ||
"version": "1.0.5", | ||
"description": "A simple couchdb client", | ||
@@ -5,0 +5,0 @@ "main": "index.js", |
# CouchDBClient | ||
## Table of Contents | ||
- [Example](#example) | ||
- [Usage](#usage) | ||
- [Documentation](#documentation) | ||
- [CouchDBClient](#couchdbclient) | ||
- [Example](#example) | ||
- [Usage](#usage) | ||
- [Documentation](#documentation) | ||
- [CouchDBClient](#couchdbclient) | ||
## Example | ||
@@ -15,7 +14,7 @@ welcome.js | ||
var client = CouchDBClient({ | ||
host: '127.0.0.1', | ||
port: '5984' | ||
host: '127.0.0.1', //The host to connect to | ||
port: '5984' //The port | ||
}); | ||
client.welcome(function (err, data) { | ||
console.log(err || data); | ||
console.log(err || data); //Hope it is not an error! | ||
}); | ||
@@ -29,5 +28,13 @@ ``` | ||
## Documentation | ||
This will be moved to another site eventually. | ||
## CouchDBClient([options]) | ||
This constructs your client. Options can have: | ||
host: the hose | ||
This constructs your client. The options object can have: | ||
host: the host to connect to. Default: 127.0.0.1 | ||
port: the port to connect to. Default: 5984 | ||
```js | ||
var CouchDBClient = require('couchdb-client'); | ||
var client = CouchDBClient({ | ||
host: example.com, | ||
port: 3000 | ||
}); | ||
``` |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
11478
38