willnorris / webmention

Go library and CLI for assisting in sending webmentions.
https://pkg.go.dev/willnorris.com/go/webmention
BSD 3-Clause "New" or "Revised" License
50 stars 5 forks source link

Man page #11

Closed Bruno-366 closed 3 years ago

Bruno-366 commented 3 years ago

Any chance you could add a man page, and link to it from the README? Right now documentation is a bit sparse, although looking at the code, it seems simple enough to use.

nekr0z commented 3 years ago

I'd argue the existing GoDoc that can be found from the README link gives enough information together with the --help option that explains the flags (or, rather, the flag, since the command line tool only has one).

However, I can see how someone might want

That being said, IMO running the command without any arguments gives enough usage tips as it is.

Bruno-366 commented 3 years ago

very well