Merge pull request #315 from satazor/patch-1
Add db.info doc.
diff --git a/README.md b/README.md
index 90c10bb..3bfbe57 100644
--- a/README.md
+++ b/README.md
@@ -31,6 +31,7 @@
- [nano.db.replicate(source, target, [opts], [callback])](#nanodbreplicatesource-target-opts-callback)
- [nano.db.changes(name, [params], [callback])](#nanodbchangesname-params-callback)
- [nano.db.follow(name, [params], [callback])](#nanodbfollowname-params-callback)
+ - [nano.db.info([callback])](#nanodbinfocallback)
- [nano.use(name)](#nanousename)
- [nano.request(opts, [callback])](#nanorequestopts-callback)
- [nano.config](#nanoconfig)
@@ -300,6 +301,16 @@
});
```
+### nano.db.info([callback])
+
+gets database information.
+
+nano.db.info(function(err, body) {
+ if (!err) {
+ console.log('got database info'', body);
+ }
+});
+
### nano.use(name)
creates a scope where you operate inside `name`.
