search

swan-bitcoin / xpub-tool

A JavaScript library to derive bitcoin addresses from extended public keys. Includes a web tool and CLI.
MIT License
47 stars 21 forks source link

docs(lib): add documentation for @swan/xpub-lib #25

Closed dergigi closed 4 years ago

dergigi commented 4 years ago

Adds JSDoc documentation to the public-facing modules of @swan/xpub-lib.

Also added various utility scripts that make working on the documentation easier, e.g.

yarn watch:docs

will watch for changes in the documentation and re-generate it.

Screenshot of generated JSDoc for reference

Screenshot_2020-09-15 JSDoc Module derivation