| 1 | pouchdb
|
| 2 | ======
|
| 3 |
|
| 4 | PouchDB is a pocket-sized database.
|
| 5 |
|
| 6 | ### Usage
|
| 7 |
|
| 8 | ```bash
|
| 9 | npm install pouchdb
|
| 10 | ```
|
| 11 |
|
| 12 | ```js
|
| 13 | var PouchDB = require('pouchdb');
|
| 14 | var db = new PouchDB('my_db');
|
| 15 | ```
|
| 16 |
|
| 17 | For full API documentation and guides on PouchDB, see [PouchDB.com](http://pouchdb.com/).
|
| 18 |
|
| 19 | This is the full, batteries-included `pouchdb` package containing code that is designed for both the Browser and Node.js. For details on PouchDB sub-packages, see the [Custom Builds documentation](http://pouchdb.com/custom.html).
|
| 20 |
|
| 21 | ### Source
|
| 22 |
|
| 23 | PouchDB and its sub-packages are distributed as a [monorepo](https://github.com/babel/babel/blob/master/doc/design/monorepo.md).
|
| 24 |
|
| 25 | For a full list of packages, see [the GitHub source](https://github.com/pouchdb/pouchdb/tree/master/packages).
|
| 26 |
|
| 27 |
|