docs: add package documentation and runnable examples

[BoxBoxJason]

Description of your changes

This PR adds a proper godoc file and more runnable examples. This will act as package documentation.

Closes #249

I have:

• Followed the git conventional commit message format.
• Made sure all changes are covered by proper tests, reaching a coverage of at least 80% when applicable.

How has this code been tested

I have:

• Made sure make lint passes to verify that the code style is correct.
• Made sure make test passes to verify that the code is working as intended.
• Made sure make e2e passes to verify that end-to-end tests pass against a real SonarQube instance.
• Added unit tests to cover the code changes.
• Added end-to-end tests if necessary.