blob: b2846bce64a8fa5c599fdd94e9d65db0c5100567 [file] [log] [blame] [view]
pouchdb
======
PouchDB is a pocket-sized database.
### Usage
```bash
npm install pouchdb
```
```js
var PouchDB = require('pouchdb');
var db = new PouchDB('my_db');
```
For full API documentation and guides on PouchDB, see [PouchDB.com](http://pouchdb.com/). For details on PouchDB sub-packages, see the [Custom Builds documentation](http://pouchdb.com/custom.html).
### Source
PouchDB and its sub-packages are distributed as a [monorepo](https://github.com/babel/babel/blob/master/doc/design/monorepo.md).
For a full list of packages, see [the GitHub source](https://github.com/pouchdb/pouchdb/tree/master/packages).