Add dedicated NuGet package README - #4
Merged
Merged
Conversation
prezaei
changed the title
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
1 participant
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.
Add a separate PACKAGE_README.md written for NuGet consumers, with installation instructions and an explanation of the analyzer configuration and build impact. Point PackageReadmeFile and the packed file entry to this document. The repository README remains independent.
This removes the HTML logo that NuGet rendered as literal text and replaces the short repository introduction with package-specific guidance.
Validation: Release package creation and inspection of the README file and nuspec metadata.