Skip to content

Commit

Permalink
Add readme
Browse files Browse the repository at this point in the history
  • Loading branch information
daleharvey committed Nov 22, 2014
1 parent 9cf720e commit ad5ecb5
Showing 1 changed file with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# pouchdb-express-router

> An Express submodule with a CouchDB style REST interface to PouchDB.
## Introduction

**pouchdb-express-router** is an expressjs routing module that provides the
minimal API to allow PouchDB instance to replicate over HTTP, it is designed
to be mounted into expressjs web application to prove the an endpoint for
PouchDB applications to sync with.

## Example Usage

Here's a sample Express app, which we'll name `app.js`.

```javascript
var express = require('express');
var app = express();
var PouchDB = require('pouchdb');

app.use('/db', require('express-pouchdb')(PouchDB));

app.listen(3000);
```

0 comments on commit ad5ecb5

Please sign in to comment.