NuGet Package README Display

richard.gagliano_3594

In going through the documentation and testing in our feeds, it doesn't look like NuGet README files are displayed within ProGet like they are for packages available on NuGet.org. I only see package description within our ProGet feeds.

Have I missed some sort of feed configuration to display the README file specified within the nuspec <readme> tag on our ProGet feeds, or is this functionality not available at this time?

Example from NuGet.org:

https://www.nuget.org/packages/Microsoft.Extensions.Configuration/8.0.0-preview.4.23259.5

Thanks,

Rich

atripp

Hi @richard-gagliano_3594 ,

Actually we reviewed this for ProGet 2023, but ultimately decided not to it.

The main reasons were,
(1) it wouldn't work well for remote packages, since we don't have the package file locally
(2) different behavior for remote and local/cached packages is confusing to explain and adds a support burden
(3) it was not trivial with the way README was implemented on NuGet and our abstractions
(4) not in demand - we've had one other request (5 years ago) for this, and it was before the spec was finalized

I suppose you could say that "demand has doubled", but probably best to wait if we have more requests for this... given that it's not trivial and the behavior may be quirky.

Cheers,
Alana

toni.wenzel

I would also like to have this feature.

pbe_9047

We also could use this feature.

atripp

Added to our PRoGet 2024 roadmap to ivnestigate/explore - it might be easier this time!

jw

We are also interested in README rendering.

I've been looking to find where the project URL is displayed, but were unable to find it. Maybe this could be added aswell?
https://learn.microsoft.com/en-us/nuget/reference/nuspec#projecturl

Also related is the releaseNotes field, that would be similar to README rendering
https://www.nuget.org/packages/Microsoft.Extensions.Configuration/9.0.0-preview.1.24080.9#releasenotes-body-tab
https://learn.microsoft.com/en-us/nuget/reference/nuspec#releasenotes

Essentially we are looking for a way to make changelog information of a given package easily accessible to developers.