search

bcoin-org / bcrypto

JS crypto library
Other
99 stars 41 forks source link

documentation #5

Closed tynes closed 5 years ago

tynes commented 6 years ago

Would autogenerating docs using jsdoc be a nice addition to this repo?

Or an updated README that specifies the different available modules?

I'd be interested in contributing this

andreyselin commented 6 years ago

Some examples of usage would also be appreciated, especially for blake2b256

chjj commented 5 years ago

@tynes, I want to stop using jsdoc. It's not maintained and it ends up being more work than it's worth (i.e. constantly recompiling and checking the output to make sure everything compiled correctly). JSDoc will get especially confused with the multiple backends (so I guess we'd only add the docs to one of the backends, but that seems like a hack).

I think I will add a series of markdown files eventually.