Skip to content

docs: Update README with badges and NuGet package links#25

Merged
snovak7 merged 1 commit into
mainfrom
24-update-readme
Jun 11, 2026
Merged

docs: Update README with badges and NuGet package links#25
snovak7 merged 1 commit into
mainfrom
24-update-readme

Conversation

@snovak7

@snovak7 snovak7 commented Jun 11, 2026

Copy link
Copy Markdown
Contributor

Closes #24

Summary by Sourcery

Update project README with status badges and NuGet package information.

Documentation:

  • Add build status and license badges to the README.
  • Replace the package description table with NuGet version badges and links for published packages.

@snovak7 snovak7 self-assigned this Jun 11, 2026
@snovak7 snovak7 added the area/documentation Improvements or additions to documentation label Jun 11, 2026
@snovak7 snovak7 linked an issue Jun 11, 2026 that may be closed by this pull request
@coderabbitai

coderabbitai Bot commented Jun 11, 2026

Copy link
Copy Markdown

Warning

Review limit reached

@snovak7, we couldn't start this review because you've reached your PR review rate limit.

More reviews will be available in 16 minutes and 57 seconds. Learn how PR review limits work.

Your organization has run out of usage credits. Purchase more credits in the billing tab to continue.

⌛ How to resolve this issue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans include higher PR review limits than trial, open-source, and free plans. In all cases, reviews become available again over time. During sustained high-volume PR review activity, CodeRabbit may temporarily slow when the next review becomes available.

Please see our Fair Usage Limits Policy for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: afab06c6-cd15-45d5-b6d6-2f95d71880e1

📥 Commits

Reviewing files that changed from the base of the PR and between 3cd2981 and e1276ec.

📒 Files selected for processing (1)
  • README.md
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch 24-update-readme

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

Comment @coderabbitai help to get the list of available commands and usage tips.

@sourcery-ai

sourcery-ai Bot commented Jun 11, 2026

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

Reviewer's Guide

Updates README documentation to add build and license badges and replace the package description table with NuGet version badges linking directly to the published packages.

File-Level Changes

Change Details Files
Add build status and license badges to the README header.
  • Insert GitHub Actions build status badge referencing the push workflow.
  • Insert Apache 2.0 license badge linking to the official license text.
README.md
Update packages section to a NuGet packages section with version badges and links.
  • Rename the packages section heading to 'NuGet Packages'.
  • Change the packages table to show package name and version instead of descriptions.
  • Add NuGet version badges for the Core and Orleans packages, each linking to its NuGet page.
README.md

Assessment against linked issues

Issue Objective Addressed Explanation
#24 Add NuGet badges for the packages listed in README.md
#24 Add a release/build status badge to the README.md
#24 Add license information (e.g., a license badge) to the README.md

Possibly linked issues

  • Update README #24: PR updates README with build status, license badges, and NuGet package badges as requested in the issue.

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

Choose a reason for hiding this comment

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

Hey - I've reviewed your changes and they look great!


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.

@snovak7 snovak7 merged commit be66eab into main Jun 11, 2026
9 of 11 checks passed
@snovak7 snovak7 deleted the 24-update-readme branch June 11, 2026 15:39
@kilo-code-bot

kilo-code-bot Bot commented Jun 11, 2026

Copy link
Copy Markdown

Code Review Summary

Status: No Issues Found | Recommendation: Merge

Files Reviewed (1 file)
  • README.md - No issues

Reviewed by step-3.7-flash-20260528 · 132,546 tokens

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update README

1 participant