Documentation improvements

[AgathaSorceress]

Improvement steps

Preview Give feedback

1. Outdated GitLab links in README should be replaced
2. A slightly more detailed description of what this project does and how it works should be added at the top of the README
3. The sample configuration could benefit from a short comment that explains what the "server" IP address refers to, to reduce ambiguity
4. The Pre-commit usage section (same as in the rest of our projects) should be added to the Contributing section of the README
5. Add pre-commit config from rust-project template