General: Improve Readme

[thomasw04]

The current readme is lacking information. Especially regarding devcontainer, nix shell, proofs, tests, coverage.
Additionally the following parts should be added:

• Badges for pipeline state.
• Brief overview about the repo structure.