README.md
1[PouchDB](http://pouchdb.com/) – The Database that Syncs!
2=========
3
4[](https://travis-ci.org/pouchdb/pouchdb) [](https://coveralls.io/github/pouchdb/pouchdb?branch=master) [](https://greenkeeper.io/) [](https://www.npmjs.com/package/pouchdb)
5
6PouchDB is an open-source JavaScript database inspired by [Apache CouchDB](http://couchdb.apache.org/) that is designed to run well within the browser.
7
8PouchDB was created to help web developers build applications that work as well offline as they do online.
9
10Using PouchDB
11-------------
12
13To get started using PouchDB, check out the [web site](http://pouchdb.com) and [API documentation](http://pouchdb.com/api.html).
14
15Getting Help
16------------
17
18The PouchDB community is active [on Freenode IRC](https://www.irccloud.com/invite?channel=pouchdb&hostname=irc.freenode.net&port=6697&ssl=1), [Slack](http://slack.pouchdb.com),in [the Google Groups mailing list](https://groups.google.com/forum/#!forum/pouchdb), and [on StackOverflow](http://stackoverflow.com/questions/tagged/pouchdb). Or you can [tweet @pouchdb](http://twitter.com/pouchdb)!
19
20If you think you've found a bug in PouchDB, please write a reproducible test case and file [a Github issue](https://github.com/pouchdb/pouchdb/issues). We recommend [bl.ocks.org](http://bl.ocks.org/) for code snippets, because some iframe-based services like JSFiddle and JSBin do not support IndexedDB in all browsers. You can start with [this template](https://gist.github.com/nolanlawson/816f138a51b86785d3e6).
21
22Prerelease builds
23----
24
25If you like to live on the bleeding edge, you can build PouchDB from source using these steps:
26
27 git clone https://github.com/pouchdb/pouchdb.git
28 cd pouchdb
29 npm install
30
31After running these steps, the browser build can be found in `packages/node_modules/pouchdb/dist/pouchdb.js`.
32
33Changelog
34----
35
36PouchDB follows [semantic versioning](http://semver.org/). To see a changelog with all PouchDB releases, check out the [Github releases page](https://github.com/pouchdb/pouchdb/releases).
37
38For a concise list of breaking changes, there's the [wiki list of breaking changes](https://github.com/pouchdb/pouchdb/wiki/Breaking-changes).
39
40Keep in mind that PouchDB is auto-migrating, so a database created in 1.0.0 will still work if you open it in 4.0.0+. Any release containing a migration is clearly marked in the release notes.
41
42Contributing
43------------
44
45We're always looking for new contributors! If you'd like to try your hand at writing code, writing documentation, designing the website, writing a blog post, or answering [questions on StackOverflow](http://stackoverflow.com/search?tab=newest&q=pouchdb), then we'd love to have your input.
46
47If you have a pull request that you'd like to submit, please read the [contributing guide](https://github.com/pouchdb/pouchdb/blob/master/CONTRIBUTING.md) for info on style, commit message format, and other (slightly!) nitpicky things like that. PouchDB is heavily tested, so you'll also want to check out the [testing guide](https://github.com/pouchdb/pouchdb/blob/master/TESTING.md).
48
){kind=link}
){kind=link}
){kind=link}
){kind=link}