Could you move the docs to godoc?

headzoo / surf

Stateful programmatic web browsing in Go.

MIT License

1.49k stars 160 forks source link

Could you move the docs to godoc? #51

Closed abhi18av closed 7 years ago

abhi18av commented 7 years ago

Hey @headzoo

I wanted to add this to the awesome-go list but the requirement is of

github.com repo:
godoc.org:
goreportcard.com:
coverage service link (gocover, coveralls etc.):

Could you help me out with this commit?

headzoo commented 7 years ago

Hi, godoc.org documents packages automatically. https://godoc.org/github.com/headzoo/surf Are you asking whether I can write better inline documentation for the godoc tool?

abhi18av commented 7 years ago

Ah, right. I'm such a noob sometimes :smile:

Well, could you just add that badge/link to the docs on the Readme ?

headzoo commented 7 years ago

Added. Also thanks for pointing out goreportcart.com. I didn't even know it existed. Pretty cool.

abhi18av commented 7 years ago

Thanks :)