Add README with badges and project overview#31
Merged
Conversation
Agent-Logs-Url: https://github.com/Tyrrrz/PowerKit/sessions/33ee8a3b-3007-433d-8118-e203fb6e7050 Co-authored-by: Tyrrrz <1935960+Tyrrrz@users.noreply.github.com>
Copilot created this pull request from a session on behalf of
Tyrrrz
April 14, 2026 20:32
View session
Tyrrrz
approved these changes
Apr 14, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a more complete README for PowerKit, aligning the repository’s landing page with other Tyrrrz projects by including status/metadata badges, a brief overview, terms of use, and installation guidance for the source-only NuGet package.
Changes:
- Add a badge block (status, build, coverage, NuGet, Discord, etc.) and a short project description.
- Add “Terms of use” section with the standard clause used across Tyrrrz projects.
- Add an “Install” section with
dotnet add packageplus compiler/compatibility notes.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
This was referenced May 1, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
PowerKit had no meaningful README. Adds one modeled after PolyShim, without a usage section.
Contents
dotnet add package PowerKit) with SDK version note