add Table of Contents and update API on README.md

[mistakia]

Update README with documentation for missing constructor (and options), public methods, and events. In addition, corrects a few event params and uniformly uses address to reference the OrbitDB address (instead of inconsistent usage of both dbname & address).

Edit: I have removed two defaultOptions properties (path & replicate) that don't appear to be used. In addition, I have removed the onProgressCallback param passed to loadFromSnapshot() that was never used.

I've also noticed that a couple events emit inconsistent params.

• load :
  https://github.com/orbitdb/orbit-db-store/blob/84aa8095c0d08fc428b8c375aa83cb7fe873bc2d/src/Store.js#L207
  https://github.com/orbitdb/orbit-db-store/blob/84aa8095c0d08fc428b8c375aa83cb7fe873bc2d/src/Store.js#L313
• replicated :
  https://github.com/orbitdb/orbit-db-store/blob/84aa8095c0d08fc428b8c375aa83cb7fe873bc2d/src/Store.js#L116
  https://github.com/orbitdb/orbit-db-store/blob/84aa8095c0d08fc428b8c375aa83cb7fe873bc2d/src/Store.js#L403

Is this desired? or should I update to have matching params?

TODO

• document constructor options
• loadMoreFrom description
• replicated event description
• closed event description
• ready event description
• load event description

New scripts:

• npm run build:docs/tocs : generates a table of contents for README.md

New dev dependencies:

• markdown-toc: generates a markdown table of contents

Fixes #26

[mistakia]

Also, loadMoreFrom takes an amount param that it never uses:

https://github.com/orbitdb/orbit-db-store/blob/e782db51e9f4bcfb808466fb69bf5169a14308f7/src/Store.js#L272-L274

Edit: Is this used anywhere? seems to be sync() but just without saving the heads to IPFS.
Edit: Waiting to get some clarity on loadMoreFrom before documenting it 😃

[mistakia]

I've noticed that the main orbit-db Store API section is incomplete/needs updating as well.

As mentioned in orbitdb-archive/orbit-db-docstore#10, perhaps I should move this PR upstream to the orbit-db repo and simply link to the relevant API section from this repo's README.md. Either way, for ease of maintenance, it would be best if one repo references the other.

[haadcode]

It'd be really great to get this PR merged as there is a lot of great documentation here that would help many users.

@mistakia are you interested to continue and finish this up? Totally fine if not and someone else can take a look.

@RichardLitt what do we need to do here from your perspective to be able to merge?

[RichardLitt]

This looks good to me - I would just work on the params, as adding comments noting it doesn't actually fix the problem. I think @mistakia made a point about what he needs clarified above in this comment.

[mistakia]

Sorry for the delay, just getting back into the swing of things.

@haadcode : As @RichardLitt has pointed out, I just need some clarity on the load/replicated events and I should be able to push the rest over the finish line.

[RichardLitt]

@aphelionz Would you be able to help here?

[aphelionz]

@mistakia Is this explanation from the orbit-db pinned issues helpful? orbitdb/orbitdb#579

[mistakia]

This is ready for review. I updated the docs to make a note that certain arguments are not emitted for load and replicated events when emitted as a result of loadFromSnapshot. Outside of the updates to the documentation, I made a couple trivial changes:

• removed an unused argument passed to loadFromSnapshot
• removed an unused property of DefaultOptions

[aphelionz]

We probably need to update the README a bit now that things like DefaultOptions have changed, and there may be some additions/removals to the API in general as well