docs: Add godoc badge to README #148
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Thanks for the contribution! |
a-h
added a commit
that referenced
this pull request
Sep 24, 2023
* docs: Add godoc badge to README Badge created via https://pkg.go.dev/badge/. * docs: add Go package badge to README.md --------- Co-authored-by: Adrian Hesketh <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I think it would be useful to have a godoc badge in the README for easy access to the package documentation. If approved, please move it to where ever you like. I just put it towards the top like most README's, although it could make sense to put it under the documentation part.
Badge created via https://pkg.go.dev/badge/.