Improve README

[gr2m]

Take https://github.com/hoodiehq/hoodie-client-account as an example. It’s a lot of work, but this can be done step-by-step, and I’m happy to work with you on it :)

Just to get this going, setup the repository locally and run tests:

git clone [email protected]:hoodiehq/hoodie-client-store.git
cd hoodie-client-store/
npm install
npm test

npm test should end with

  total:     173
  passing:   173
  duration:  1.3s

Playing with the APIs is probably simplest in a browser. We don’t have a demo server build in (yet), but you can do this:

# build the client story library for the browser
npm run build
# copy the client store code to your clipboard
cat dist/hoodie-client-store.js | pbcopy

Now open any website like http://example.com/, open browser console, and paste in the code from your clip board. Store is now available :)

Now you can run the code shown in the README API section and see how it behaves.

Also compare https://github.com/hoodiehq/pouchdb-hoodie-api & https://github.com/hoodiehq/pouchdb-hoodie-sync where most of the APIs are coming from, and look around the code :)