Repo Documentation & README file

[adoublef]

I can see that because this was copied from a template repo, a lot of the docs have a lot boilerplate & we need to fill that.

I think firstly, we need to work on the public README file. And then once that is sorted think about how we are going to document. I have opened a branch to begin working on the README for now

[hansvb]

Also see rog-golang-buddies/golang-template-repository#72 (comment)

As I grok it, the documentation provided by the rog-golang-buddies team was meant to make the devs familiar with the CI-integrations (and I assume will remain to do so for the time being as these template might undergo some changes as well).

I propose to leave this documentation intact for now as it will probably be updated a few more times?

That said: in the future we will need to refactor this (maybe even completely remove/rehaul) once we want this to be end-user-documentation.