wgctrl: expand documentation and add examples

[g00nix]

This projects looks like it will have a good future in the FOSS community, however for people to jump in, extended documentation would be good, preferably in-the-face (starting with README.md) and noob-friendly. There already is a good code sample here, however, people new to wireguardctl have to read through the project to find this sample code.

I think it would be useful to have something like this.

[mdlayher]

I'd prefer to keep the README fairly brief, but I can certainly expand upon the GoDoc documentation.

[g00nix]

I'd prefer to keep the README fairly brief, but I can certainly expand upon the GoDoc documentation.

Sounds great as long as godoc is linked in the readme 👍

[mdlayher]

@gun1x it is already, see the GoDoc badge.

[almereyda]

Additionally, since this is already packaged for Fedora 34 at least, the binary wgctrl could also be a little more self documenting. Right now it is not possible to find out what it is here for:

$ wgctrl

$ wgctrl --help
Usage of wgctrl:

$ man wgctrl
Kein Handbucheintrag für wgctrl vorhanden