doc: update readme

[l1b0k]

[codecov[bot]]

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 24.92%. Comparing base (9edf477) to head (7d654c5). Report is 3 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #701      +/-   ##
==========================================
+ Coverage   24.90%   24.92%   +0.02%     
==========================================
  Files         125      125              
  Lines       17147    17147              
==========================================
+ Hits         4270     4274       +4     
+ Misses      12414    12410       -4     
  Partials      463      463              

Flag	Coverage Δ
unittests	24.92% <ø> (+0.02%)	:arrow_up:

Flags with carried forward coverage won't be shown. Click here to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

[BSWANG]

markdown lint failed