Add documenation section to the README

[liam-lloyd]

To make our API documentation easier to find an use, this commit adds a section to the readme describing how to do these things.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 94.47%. Comparing base (1d086a1) to head (b31dd8f).
Report is 7 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #142      +/-   ##
==========================================
- Coverage   94.52%   94.47%   -0.05%     
==========================================
  Files          81       82       +1     
  Lines        1497     1521      +24     
  Branches      226      228       +2     
==========================================
+ Hits         1415     1437      +22     
- Misses         75       77       +2     
  Partials        7        7              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[meisekimiu]

At some point we should look into hosting this documentation on something like Github Pages automatically.