Fix example in docs, match docs with README, add downgrade check

[tylerjthomas9]

Fixed the example in the README and expanded the README/docs homepage to match each other.

I added a Downgrade action that checks the minimum bounds on all the compat entries (and fixed all the issues that came up).

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 75.55%. Comparing base (6d6ff0f) to head (27040cb).

Additional details and impacted files

@@           Coverage Diff           @@
##             main      #31   +/-   ##
=======================================
  Coverage   75.55%   75.55%           
=======================================
  Files           6        6           
  Lines         180      180           
=======================================
  Hits          136      136           
  Misses         44       44           

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

[ablaom]

Looks good to me. I didn't actually run the examples and assume you did.

Didn't know about the downgrade action. So, we run tests first using latest deps, and then again using latest Julia and oldest deps compatible with bounds in Project?

[ablaom]

Assuming this closes #30, yes?

[tylerjthomas9]

Looks good to me. I didn't actually run the examples and assume you did.

I somehow missed the one in the readme. It's the same one from the examples folder that we run in the tests.

Didn't know about the downgrade action. So, we run tests first using latest deps, and then again using latest Julia and oldest deps compatible with bounds in Project?

Yes, the downgrade action just runs the tests with the lower bounds of each dependency. https://www.stochasticlifestyle.com/semantic-versioning-semver-is-flawed-and-downgrade-ci-is-required-to-fix-it/

[tylerjthomas9]

Assuming this closes #30, yes?

Yes

[ablaom]

Thank you 🙏🏾