README improvements

[mikeingold]

No description provided.

[mikeingold]

@JoshuaLampert let me know what you think of the updated README in this branch.

[JoshuaLampert]

Looks pretty good!

[mikeingold]

@JoshuaLampert do you have an opinion on bumping the package version within this PR vs separately? I’ve currently got the main branch protected from direct commits so it’s a bit extra overhead to PR a version bump alone.

[JoshuaLampert]

It's totally fine to bump the version number in this PR.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 83.85%. Comparing base (46d1c4a) to head (d0529bf).
Report is 1 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main      #70   +/-   ##
=======================================
  Coverage   83.85%   83.85%           
=======================================
  Files           7        7           
  Lines         353      353           
=======================================
  Hits          296      296           
  Misses         57       57           

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

[mikeingold]

Am I missing any review items? I’m still seeing a flag for 1 missing suggestion but everything looks resolved on my end.

[JoshuaLampert]

Thanks!

[JoshuaLampert]

Everything looks fine on my end.

[mikeingold]

Great. Thanks!

[JoshuaLampert]

Oh, I wanted to enable auto-merge, but missed that CI is not a required status check. I suggest to make passing CI required.