roy-replicator

roy-replicator 
==============
Node implementation of the CouchDB replication protocol.

Usage
-----
``js
var adapter = require('roy-request');
var roy = require('roy-replicator');

roy.replicate({
source: adapter('http://localhost:5984/my-source'),
target: adapter('http://localhost:5984/my-target')
}, function(err, resp) {
// Oh Pris!
});
`

This should also be possible (but I haven't tested yet):
`js
var adapter = require('pouchdb');
`

Goals
-----


* Gain deeper understanding of CouchDB replication
* Good readability and testability
* CouchDB replicator compatibility
* Be nearly as fast as CouchDB
* Small browserified footprint
* PouchDB compatibility (replace roy-request with pouchdb)

Resources
---------
* CouchDB Replication Protocol by Alexander Shorin
* Jens Alfkes description of the replication algorithm
* CouchDB Replication Protocol on Data Protocols
* RCouchs Replication Algorithm in pseudo code

Development
-----------
* Lint the code with npm run jshint
* Run the tests with npm test
* Browserify with npm run build
* List TODOS with npm run todos
* Run performance tests with npm run perf`

License
-------
Copyright (c) 2013 Johannes J. Schmidt, TF

Licensed under the MIT license.