Skip to content

docs: align README badges with OffsetInspect (crates.io, release, platform, security) - #20

Merged
warpedatom merged 1 commit into
mainfrom
docs/match-badges
Jul 27, 2026
Merged

docs: align README badges with OffsetInspect (crates.io, release, platform, security)#20
warpedatom merged 1 commit into
mainfrom
docs/match-badges

Conversation

@warpedatom

@warpedatom warpedatom commented Jul 27, 2026

Copy link
Copy Markdown
Owner

Summary by Sourcery

Documentation:

  • Revise README header badges to match OffsetInspect style, including crates.io, release, license, platform, CI, security, and X profile badges.

@sourcery-ai

sourcery-ai Bot commented Jul 27, 2026

Copy link
Copy Markdown
Contributor
Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

README badges are restructured into a centered HTML block and expanded to match OffsetInspect’s badge set (crates.io, releases, license, Rust, platforms, CI, security policy, social).

File-Level Changes

Change Details Files
Rework and expand the README badge section to a centered HTML block with a richer set of badges.
  • Replace markdown-style CI, License, and X badges with an HTML

    block containing multiple and elements.

  • Add crates.io version badge linking to the offsetscan crate.
  • Add GitHub release badge showing the latest release version.
  • Switch license badge to use GitHub license shield while keeping link to local LICENSE file.
  • Add badges for Rust implementation and supported core platforms (Windows, Linux, macOS).
  • Update CI badge to use GitHub Actions workflow status shield with explicit branch and label.
  • Add security policy badge linking to SECURITY.md.
  • Retain and slightly reformulate the X (Twitter) badge within the new HTML layout.
README.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey - I've left some high level feedback:

  • Since the badges are now wrapped in raw HTML, consider verifying how this renders across common Markdown viewers (e.g., crates.io, docs.rs, GitHub web, GitHub mobile) and adjust alignment or layout if any of them degrade the badge display.
  • Some of the alt text values are quite verbose or redundant (e.g., repeating the handle or description already visible in the badge); tightening these to concise, descriptive labels can improve accessibility for screen readers.
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- Since the badges are now wrapped in raw HTML, consider verifying how this renders across common Markdown viewers (e.g., crates.io, docs.rs, GitHub web, GitHub mobile) and adjust alignment or layout if any of them degrade the badge display.
- Some of the `alt` text values are quite verbose or redundant (e.g., repeating the handle or description already visible in the badge); tightening these to concise, descriptive labels can improve accessibility for screen readers.

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@warpedatom
warpedatom merged commit 73b7e08 into main Jul 27, 2026
6 checks passed
@warpedatom
warpedatom deleted the docs/match-badges branch July 27, 2026 17: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