kitsunet-js icon indicating copy to clipboard operation
kitsunet-js copied to clipboard

Documentation of API functionality.

Open ChrisCates opened this issue 6 years ago • 0 comments

Would be nice to document the API functionality for future use.

The following modules need to be documented:

  • [ ] eth-provider
  • [ ] kitsunet-peer
  • [ ] slice-fetcher
  • [ ] telemetry
  • [ ] utils

Makes sense to work on documenting these features via Markdown as well as annotating in the code itself while integrating into Metamask.

When external modules (kitsunet-block-tracker, kitsunet-slice-tracker) are leveraged... We should direct them to those repositories for more informations.

ChrisCates avatar Nov 17 '18 18:11 ChrisCates