docs: Update README and documentation

[yohamta]

No description provided.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 55.55%. Comparing base (7fe5c8b) to head (645ee57).
Report is 2 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #787      +/-   ##
==========================================
- Coverage   55.59%   55.55%   -0.04%     
==========================================
  Files          73       73              
  Lines        7904     7904              
==========================================
- Hits         4394     4391       -3     
- Misses       3132     3134       +2     
- Partials      378      379       +1     

see 1 file with indirect coverage changes

---

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 7fe5c8b...645ee57. Read the comment docs.