Skip to content

Include root README.md in all NuGet packages#1885

Merged
lahma merged 2 commits intomasterfrom
copilot/improve-readme-for-package
Mar 1, 2026
Merged

Include root README.md in all NuGet packages#1885
lahma merged 2 commits intomasterfrom
copilot/improve-readme-for-package

Conversation

Copy link
Contributor

Copilot AI commented Mar 1, 2026

NuGet packages lacked a readme, leaving users without getting-started information on the package page.

Changes

  • Directory.Build.props: Added <PackageReadmeFile>README.md</PackageReadmeFile> and a global ItemGroup that packs the repo root README.md into all NuGet packages via $(MSBuildThisFileDirectory)README.md
<PackageReadmeFile>README.md</PackageReadmeFile>
...
<ItemGroup>
    <None Include="$(MSBuildThisFileDirectory)README.md" Pack="true" PackagePath="\" />
</ItemGroup>

Applies to all SDK-style projects (NJsonSchema, NJsonSchema.Annotations, NJsonSchema.Yaml, NJsonSchema.CodeGeneration, NJsonSchema.CodeGeneration.CSharp, NJsonSchema.CodeGeneration.TypeScript) without any per-project changes.

Original prompt

This section details on the original issue you should resolve

<issue_title>Improve base package readme</issue_title>
<issue_description>Is your feature request related to a problem? Please describe.
The current package readme is not informative about how to use the package

Describe the solution you'd like

The nuget package should be using the same readme as the repo to make it as easy as possible for a user to get started with the package.

Describe alternatives you've considered
Accept needing to go to github to get information

Additional context
N/a</issue_description>

Comments on the Issue (you are @copilot in this section)


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Co-authored-by: lahma <171892+lahma@users.noreply.github.com>
Copilot AI changed the title [WIP] Update base package readme for better usability Include root README.md in all NuGet packages Mar 1, 2026
Copilot finished work on behalf of lahma March 1, 2026 19:53
@lahma lahma marked this pull request as ready for review March 1, 2026 20:02
@lahma lahma merged commit dad3236 into master Mar 1, 2026
2 checks passed
@lahma lahma deleted the copilot/improve-readme-for-package branch March 1, 2026 20:02
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.

Improve base package readme

2 participants