[hampsterx]

Summary

• Show build, release and support status at a glance on the repo and PyPI pages: badges for CI, PyPI version, supported Python versions, license and PEP 561 typing
• Version, Python and license badges read from PyPI metadata, so they track releases without hand edits
• Replace the "not yet released, may change before v0.1.0" status note, which v0.1.2 on PyPI contradicts, with a pre-1.0 stability note

Docs: updated

Backwards compatibility

README only. No code, packaging or API change.

Review

Clean, no issues found. Prose-only diff below the review threshold; markdownlint shows no findings on the changed lines (the errors it reports at README lines 83 and 91 predate this change).

Changes

 README.md | 8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)

Test plan

• Each badge URL fetched and renders the expected value: CI passing, pypi v0.1.2, python 3.9-3.13, license MIT
• markdownlint clean on the changed lines
• No visual effect.

Summary by CodeRabbit

• Documentation
  • Updated the README with project status and API compatibility information, and added badges for CI, package availability, supported Python versions, licensing, and typing.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

• Configuration used: defaults
• Review profile: CHILL
• Plan: Advanced
• Run ID: 9c937229-4a9a-4940-8f6c-32ce5bb88d54

📥 Commits

Reviewing files that changed from the base of the PR and between db747d8 and 1327bf7.

📒 Files selected for processing: 1

• README.md

Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.

📝 Walkthrough

The README adds CI, PyPI, license, and typing badges. It changes the project status to pre-1.0 and states that API changes may occur between minor versions.

Changes: README updates

Layer / File(s)	Summary
Project status and badges README.md	The README adds CI, PyPI, license, and typing badges. It updates the project status to “pre-1.0” and changes the API-change caveat to between minor versions.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~3 minutes

Change: Other

Merge Risk: ⚪ Minimal · up to 1327b

This documentation-only change has no established runtime or release risk and is ready to merge after normal checks.

Pre-merge checks: 5

Check name	Status	Explanation
Description Check		Check skipped - CodeRabbit’s high-level summary is enabled.
Title check		The title clearly and concisely describes the README changes: adding status badges and updating the project to a pre-1.0 status.
Docstring Coverage		No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check		Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check		Check skipped because no linked issues were found for this pull request.

Full details: Docstring Coverage

Explanation

No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.)

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Commit to this branch
• Create a new PR

• Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}