[WIP] Awesome Documentation Endeavour

[dignifiedquire]

Ref ipfs/js-ipfs#615
Preview https://libp2p.github.io/js-libp2p-crypto

[richardschneider]

@dignifiedquire awesome effort to document this API. Will this be merged anytime soon?

I want to add PKCS #8 to the library, but would prefer to base it on your changes.

[carsonfarmer]

Just to update, the types that were recently added to this repo provide pretty much full documentation for all exposed APIs. They could be used to generate code documentation via:

npx typedoc --mode file --includeDeclarations --excludeExternals ./src/index.d.ts

[jacobheun]

Closing this as it's quite stale. We've been doing more work with TS integration in Aegir recently, so we should be able to leverage those updates in the near future to continue docs improvements.