(#3577) - edit intro docs

The "Learn" page is probably the first place where
users will land after the home page, and I wanted to
clean it up and update the description a bit.

As for the API, I cleaned up some small inconsistencies
and added a longer intro section on promises/callbacks.
At some point, I would like to go in there and just remove
the callback examples entirely. I think we should deprecate
the callback API.
2 files changed
tree: 74784385f948505e79fe85c45d3a9378ebd90fe1
  1. bin/
  2. docs/
  3. lib/
  4. scripts/
  5. tests/
  6. .gitignore
  7. .jshintignore
  8. .jshintrc
  9. .npmignore
  10. .travis.yml
  11. bower.json
  12. component.json
  13. CONTRIBUTING.md
  14. LICENSE
  15. package.json
  16. README.md
  17. TESTING.md
README.md

PouchDB - The Javascript Database that Syncs

Build Status

PouchDB was written to help web developers build applications that work as well offline as well as they do online, applications save data locally so the user can use all the features of an app even while offline and synchronise the data between clients so they have up to date data wherever they go.

PouchDB is a free open source project, written in Javascript by these wonderful contributors and inspired by Apache CouchDB.

Using PouchDB

To get started using PouchDB check out our Documentation and the API Documentation.

Contributors

If you want to get involved then check out the contributing guide

Example

var db = new PouchDB('dbname');

db.put({
 _id: 'dave@gmail.com',
 name: 'David',
 age: 68
});

db.changes().on('change', function() {
  console.log('Ch-Ch-Changes');
});

db.replicate.to('http://example.com/mydb');