Monday, January 10, 2022

NuGet–Add a README to your NuGet Package

Did you know that yu can pack a README.md file in your NuGet Package and that it will be rendered on NuGet.org? NuGet.org supports this (new) feature for some time but I didn’t had time so far to try it out. 

To use it, you need to have first of all an README.md file in your Repo. This is already the case for my Extensions.Caching.PostgreSQL repo:

Now I need to update my project file and reference the README.md:


After deploying the updated package, my Readme file becomes visible on Nuget.org:

More information: https://devblogs.microsoft.com/nuget/add-a-readme-to-your-nuget-package/