docs: implement a doc.go file to provide high level usage and code usage of this package
Closed this issue · 1 comments
This issue supersedes #32 and its issue #31 in which it I had to mistakenly dig through the source code of GenEd25519Key and extracted out a few helpers to retrieve the public key.
However, @ethanfrey and @ebuchman gave me guidance on the PR #32 that we can in fact invoke
GenEd25519Key().PubKey() which will retrieve the public key.
A doc.go file is a nice way for us to cut the bus factor for our code as well as make it really simple for other developers to pick out and reference code. It also gives a nicer higher level introduction to our packages and provides quick documentation that's viewable by godoc. We talked about this offline in the Slack channel as per exhibit[0]
exhibit[0]
If so, we can do such a thing as https://github.com/golang/go/blob/0202aa8ec79bf700732812624eedcec3e6e300ad/src/net/http/doc.go#L5-L107 which then gives the Overview at https://golang.org/pkg/net/http/
which gives