New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add a README to NuGet Packages #124

Open

5 tasks

petrsvihlik opened this issue May 14, 2021 · 1 comment

Assignees

Labels

Owner

petrsvihlik commented May 14, 2021 •

edited

Motivation

Increase adoption

Implementation

Create a README inside a project folder (e.g. https://github.com/petrsvihlik/WopiHost/tree/master/WopiHost.Url)
Add the README reference to the project file as described at https://devblogs.microsoft.com/nuget/add-a-readme-to-your-nuget-package/#add-a-readme-in-your-project-file-recommended
Document the public API of the package (create a short sample per each method) - example

Progress

Additional context

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

petrsvihlik added the enhancement label

petrsvihlik added this to To do in v3 via automation

Owner Author

petrsvihlik commented Jun 30, 2021

https://devblogs.microsoft.com/dotnet/package-validation/

petrsvihlik assigned dvojitywendy

petrsvihlik removed this from To do in v3

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment