search

multiformats / js-cid

CID implementation in JavaScript
MIT License
97 stars 39 forks source link

docs: move API docs into README #56

Closed mikeal closed 5 years ago

mikeal commented 5 years ago

I end up referring to these docs often and the generated documentation is not very useful or informative.

I wrote up more human readable docs and put them in the README to replace the generated docs. This API isn't so large that we can't just document it in the README.

mikeal commented 5 years ago

@vmx resolved the comments you made previously, should be ready to merge now.

vmx commented 5 years ago

CI failed as the commit message had a full stop at the end of the header line. But as I squash the commits that's a non-issue.