docs: Add README doc

[ianlewis]

Description:

Add documentation to the README

Related Issues:

Fixes #91

Checklist:

• Review the CONTRIBUTING.md documentation.
• Add a reference to a related issue in the repository.
• Add a description of the changes proposed in the pull request.
• Add unit tests if applicable.
• Update documentation if applicable.
• Add a note in the CHANGELOG.md if applicable.

[codecov-commenter]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 82.80%. Comparing base (43462d6) to head (f151e7c).

Additional details and impacted files

@@           Coverage Diff           @@
##             main      #93   +/-   ##
=======================================
  Coverage   82.80%   82.80%           
=======================================
  Files           3        3           
  Lines         378      378           
=======================================
  Hits          313      313           
  Misses         46       46           
  Partials       19       19