add some basic documentation

[codecov[bot]]

Codecov Report

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

Project coverage is 77.86%. Comparing base (ad7b135) to head (c4f3bcc). Report is 5 commits behind head on main.

Additional details and impacted files

```diff @@ Coverage Diff @@ ## main #54 +/- ## ======================================= Coverage 77.86% 77.86% ======================================= Files 16 16 Lines 768 768 ======================================= Hits 598 598 Misses 170 170 ```

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