doc(readme): update api docs

[noneback]

No description provided.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 91.78%. Comparing base (bb2c4b7) to head (db223a5).
Report is 1 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main      #49   +/-   ##
=======================================
  Coverage   91.78%   91.78%           
=======================================
  Files          12       12           
  Lines         633      633           
=======================================
  Hits          581      581           
  Misses         37       37           
  Partials       15       15           

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

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.

---

🚨 Try these New Features:

• Flaky Tests Detection - Detect and resolve failed and flaky tests