dotnet-sdk-contrib icon indicating copy to clipboard operation
dotnet-sdk-contrib copied to clipboard

Add README to the package

Open askpt opened this issue 6 months ago • 0 comments

Instructions for Adding a README to a NuGet Package

  1. Create or update a README.md file in the root of the project repository.
  2. In your .csproj file, add the following property to include the README in your NuGet package:
<PackageReadmeFile>README.md</PackageReadmeFile>
  1. Ensure the README.md provides clear usage instructions, installation steps, and relevant documentation for package users.
  2. When packing your NuGet package (e.g., using dotnet pack), the README will be included and displayed on nuget.org. For more details, see the official NuGet documentation on package READMEs.

Deprecation Notice

We plan to rename this package to remove the contrib suffix. Please add to the README that the current package will be deprecated in favour of the new package name in a future release.

askpt avatar Jun 11 '25 12:06 askpt