Add proper documentation / examples

[fako1024]

Prior to (or shortly after) initial release the documentation should be straightened out to improve usability beyond the primary use case of goProbe.

DoD

• Finalize README.md (content + badges)
• Add generic documentation for main sub-packages (e.g. via the file headers)
• Add better snippets for the individual use cases (beyond stuff in examples)