updating readme and contributing

[jaredwray]

Please check if the PR fulfills these requirements

• Followed the Contributing guidelines.
• Tests for the changes have been added (for bug fixes/features) with 100% code coverage.
• Docs have been added / updated (for bug fixes / features)

What kind of change does this PR introduce? (Bug fix, feature, docs update, ...)
updating readme and contributing

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (a45fdef) to head (6bde87f).
Report is 2 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff            @@
##              main        #8   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            1         1           
  Lines           46        46           
  Branches        12        12           
=========================================
  Hits            46        46           

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