update readme documentation

3box / 3box-js

3Box JavaScript SDK: User identities, storage, messaging

MIT License

207 stars 65 forks source link

update readme documentation #63

Closed oed closed 5 years ago

oed commented 6 years ago

profileStore -> public privateStore -> private ThreeBox -> Box

oed commented 6 years ago

Link to KEY-USAGE.md Maybe give KEY-USAGE a more descriptive name Make sure edits in README are reflected in readme-template (otherwise they will be removed next time the readme is generated) Do a general cleanup so that everything looks good and understandable.

oed commented 6 years ago

Also make sure that all of the API documentation in 3box.js and keyValueStore.js is up to date

oed commented 6 years ago

generate readme on prepublish hook