added docs to readme

[BadPrograms]

No description provided.

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 86.56%. Comparing base (a8fe5d3) to head (c0dd25b).
⚠️ Report is 2 commits behind head on v3.x.

Additional details and impacted files

@@           Coverage Diff           @@
##             v3.x     #103   +/-   ##
=======================================
  Coverage   86.56%   86.56%           
=======================================
  Files          20       20           
  Lines        1831     1831           
=======================================
  Hits         1585     1585           
  Misses        246      246           

☔ 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.