search

xamarin / GooglePlayServicesComponents

Other
315 stars 146 forks source link

[IMPROVEMENT] Nuget Readme included in the package #804

Closed moljac closed 1 year ago

moljac commented 1 year ago

Does this change any of the generated binding API's?

No.

Describe your contribution

NuGet best practices recommend adding readme.[txt,md] to each package. Otherwise following warning is emitted:

The package  is missing a readme. Go to https://aka.ms/nuget/authoring-best-practices/readme to learn why package readmes are important.

This PR adds readme.md to NuGet packages.

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

https://devblogs.microsoft.com/nuget/write-a-high-quality-readme-for-nuget-packages/

https://github.com/NuGet/Home/issues/12070

https://raw.githubusercontent.com/lyndaidaii/NuGetReadMeTemplate/main/README.md

Verification

Result: