Improves repository documentation

[ppkarwasz]

Closes #112

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (a15a744) to head (f154d52).
Report is 1 commits behind head on main.

Additional details and impacted files

@@             Coverage Diff             @@
##                main      #228   +/-   ##
===========================================
  Coverage     100.00%   100.00%           
- Complexity       116       119    +3     
===========================================
  Files              8         8           
  Lines            208       216    +8     
  Branches          38        38           
===========================================
+ Hits             208       216    +8     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.