Nicer go doc

[oliverpool]

Congrats on the v2 release !

The go doc could look better, with the following improvements:

• link to https://pkg.go.dev/github.com/mochi-co/mqtt/v2 from the readme badge (it currently links to v1)
• add a newline between SPDX-Comment and package line to prevent is showing in the doc (see https://github.com/fluhus/godoc-tricks/blob/master/doc.go#L1-L5 for an example)

[mochi-co]

Thanks @oliverpool! I have implemented your suggestions as v2.0.2 - hopefully it fixes the issue once pkg.go.dev recaches.

[oliverpool]

👍🏼
https://github.com/mochi-co/mqtt/blob/v2.0.2/fanpool.go is still missing a newline

[oliverpool]

To preview the documentation locally, you can use the godoc cli (I also wrote an http documentation renderer: https://code.pfad.fr/vanitydoc , which should show a similar output)

[mochi-co]

Ahh good catch! Should now be fixed, so I've issued the v2.0.2 release with these changes. I can't check locally right now but hopefully that resolves the remaining issue :)

[mochi-co]

Looks like this is fixed!