Repository navigation
Add reference the README.md in the package - #4
Merged
Merged
Conversation
nowsprinting
requested review from
CyTakayukiKiyohara,
Copilot and
sakumanaoki
January 14, 2026 11:20
There was a problem hiding this comment.
Pull request overview
This PR adds README support to the NuGet package by configuring the PackageReadmeFile property in the .csproj file, following Microsoft's official guidance for including a README in NuGet packages.
Changes:
- Added
PackageReadmeFileproperty to include README.md in the NuGet package
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
sakumanaoki
approved these changes
Jan 15, 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.
Changes
Add
PackageReadmeFileproperty into the .csproj filesee: https://devblogs.microsoft.com/dotnet/add-a-readme-to-your-nuget-package/#add-a-readme-to-your-package