blob: cda0fb09ff2e152ce6ee3fbed50945c0669cb3b1 [file] [log] [blame] [view]
pouchdb-replication
======
PouchDB's replication and sync algorithm, as a plugin.
### Usage
```bash
npm install pouchdb-replication
```
```js
PouchDB.plugin(require('pouchdb-replication'));
var db = new PouchDB('mydb');
db.replicate(/* see replicate/sync API docs for full info */);
```
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).