Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

README.md: add GoDoc badge #32

Merged
merged 1 commit into from
Aug 3, 2018
Merged

README.md: add GoDoc badge #32

merged 1 commit into from
Aug 3, 2018

Conversation

mdlayher
Copy link
Contributor

@mdlayher mdlayher commented Aug 2, 2018

One of the first things I look for on a Go package's README is a link to godoc.org. I notice you do have one at the bottom of the README, but I also think the badge is a nice and clear way of linking to package documentation near the top of the README as well.

I didn't add it in this PR because it's a bit more subjective, but Go Report Card is another good one to consider: https://goreportcard.com/report/crawshaw.io/sqlite. If you'd like, I can add that as well.

Thanks for this package!

@crawshaw crawshaw merged commit 7607d66 into crawshaw:master Aug 3, 2018
@crawshaw
Copy link
Owner

crawshaw commented Aug 3, 2018

Thanks!

On go report card: not interested. It includes a lot of silly checks, especially golint.

@mdlayher mdlayher deleted the mdl-readme-godoc branch August 3, 2018 16:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants