update readme

[bestksl]

Description

A brief description of the change.

Related Issues

Fixes #123

Checklist

• I have read the Contributing Guide
• My code follows the style guidelines of this project
• I have tested my changes
• I have updated the documentation (if needed)

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 13.00%. Comparing base (e8e34b4) to head (aa71e4d).
⚠️ Report is 21 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main      #73   +/-   ##
=======================================
  Coverage   13.00%   13.00%           
=======================================
  Files          24       24           
  Lines        1953     1953           
=======================================
  Hits          254      254           
  Misses       1690     1690           
  Partials        9        9           

Flag	Coverage Δ
unittests	13.00% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

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

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.