Skip to content

docs: add crates.io badge to README.md - #549

Merged
2bndy5 merged 1 commit into
mainfrom
crates-io-badge
Nov 3, 2026
Merged

2bndy5 merged 1 commit into
mainfrom
crates-io-badge

Conversation

@2bndy5

@2bndy5 2bndy5 commented Nov 3, 2026 •

Copy link
Copy Markdown
Collaborator

Summary

It didn't seem consistent to have badges for Python and Node.js packages but no crates.io badge for the rust package.

I yanked all the old RC releases on crates.io. Now, the badge accurately shows the latest release: crates.io-badge

Related Issues

Summary by CodeRabbit

  • Documentation
    • Added a Crates.io version badge to the Rust installation section.

It didn't seem consistent to have badges for Python and Node.js packages but no crates.io badge for the rust package.

I yanked all the old RC releases on crates.io. Now, the badge accurately shows the latest release (rc.25).
@2bndy5
2bndy5 marked this pull request as ready for review November 3, 2026 02:01
@coderabbitai

coderabbitai Bot commented Nov 3, 2026

Copy link
Copy Markdown
Contributor

Review in Change Stack →

No actionable comments were generated in the recent review.

Walkthrough

The README adds a Crates.io version badge to the Rust installation section and defines the badge image and package links.

Changes: Crates.io Version Badge

Layer / File(s) Summary
Badge display and links
README.md
The Rust installation section displays the Crates.io version badge. Reference definitions link to the badge image and Crates.io package.

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

Merge Risk: Minimal · up to c9d51

The badge shows the intended release, and no merge-blocking issue remains.

Pre-merge checks: Passed 5
Check name Status Explanation
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check Passed The title clearly and concisely describes the README documentation change: adding a Crates.io badge.
Docstring Coverage Passed No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentat…
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Full details: Docstring Coverage

Explanation

No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentation-only edits and deletions within surviving functions are included; unchanged diff context and fully deleted functions are excluded. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.)

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

Tip

🎯 Customize your risk assessments

Guide how CodeRabbit assesses merge risk and security architecture risk. Highlight sensitive changes and explain your security boundaries using Merge Risk Instructions and Security Risk Instructions in your review settings. Security architecture risk assessments require the Advanced plan or above.

✅ Automatic approvals, with your rules

Let CodeRabbit approve pull requests once required threads are resolved, pre-merge checks pass, and your risk limits are met. Enable Automatic approvals in review settings, with overrides for teams or file paths.

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

CodeRabbit Verify

  • Run CodeRabbit Verify to test the changes in this pull request.
Recent review info
Run configuration
  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: Repository UI (base), Organization UI (inherited)
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 0d9d35d0-ffb9-4ac5-a6f2-374004520000
Commits

Reviewing files that changed from the base of the PR and between 389dde6 and c9d5114.

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.

@2bndy5
2bndy5 merged commit 8bf0fa8 into main Nov 3, 2026
20 checks passed
@2bndy5
2bndy5 deleted the crates-io-badge branch November 3, 2026 02:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant