Updated README doc

[Aman-Surkar]

Checklist before submitting

• Did you read the contributor guide?
• Did you update any affected documentation?
• Did you write any tests to validate this change?

Description

Fixes # (issue).

Review process to land

1. All tests and other checks must succeed.
2. At least one maintainer must review and approve.
3. If any maintainer requests changes, they must be addressed.

[codecov-commenter]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.32%. Comparing base (3e2ce70) to head (9aeed42).

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #221   +/-   ##
=======================================
  Coverage   88.32%   88.32%           
=======================================
  Files          25       25           
  Lines        2184     2184           
=======================================
  Hits         1929     1929           
  Misses        255      255           

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

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.