chore: update readme for inclusion in the docs

[beeme1mr]

This PR

• Update the readme so it renders nicely in the docs

[codecov[bot]]

Codecov Report

Merging #193 (b9edf1e) into main (6916ff9) will not change coverage. The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #193   +/-   ##
=======================================
  Coverage   78.63%   78.63%           
=======================================
  Files          10       10           
  Lines        1203     1203           
=======================================
  Hits          946      946           
  Misses        230      230           
  Partials       27       27           

:mega: We’re building smart automated test selection to slash your CI/CD build times. Learn more