forked from pouchdb/pouchdb-express-router
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
9cf720e
commit ad5ecb5
Showing
1 changed file
with
24 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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); | ||
``` |