docs: update readme docs

[cubxxw]

🔍 What type of PR is this?

👀 What this PR does / why we need it:

• My pull request adheres to the code style of this project
• My code requires changes to the documentation
• I have updated the documentation as required
• All the tests have passed

🅰 Which issue(s) this PR fixes:

Fixes #

📝 Special notes for your reviewer:

🎯 Describe how to verify it

📑 Additional documentation e.g., RFC, notion, Google docs, usage docs, etc.:

[sweep-ai]

Apply Sweep Rules to your PR?

• Apply: Leftover TODOs in the code should be handled.
• Apply: All new business logic should have corresponding unit tests in the tests/ directory.
• Apply: Any clearly inefficient or repeated code should be optimized or refactored.

[codecov]

Codecov Report

Merging #1304 (37328e0) into main (a4b28c9) will not change coverage.
The diff coverage is n/a.

❗ Current head 37328e0 differs from pull request most recent head b039d6d. Consider uploading reports for the commit b039d6d to get more accurate results

@@          Coverage Diff          @@
##            main   #1304   +/-   ##
=====================================
  Coverage   2.44%   2.44%           
=====================================
  Files         13      13           
  Lines        778     778           
=====================================
  Hits          19      19           
  Misses       756     756           
  Partials       3       3