Add existing README.md files to NuGet packages

[adamsitnik]

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

This should include our existing README.md in the NuGet packages, which should get them displayed at NuGet.org

Example from some Azure SDK NuGet package:

@ViktorHofer could you please verify the correctness of MSBuild syntax?

I've tested it by running the following command, changing the file extension to .zip and opening it with file explorer:

dotnet pack .\src\HealthChecks.Azure.KeyVault.Secrets\ -c Release -o .\artifacts

[adamsitnik]

I was finally able to get it working.

It's present for the packages that do have README.md:

And it's not for the ones that don't:

[codecov-commenter]

Codecov Report

Merging #2041 (7075015) into master (7060bdd) will decrease coverage by 1.72%.
Report is 4 commits behind head on master.
The diff coverage is 97.66%.

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

@@            Coverage Diff             @@
##           master    #2041      +/-   ##
==========================================
- Coverage   69.06%   67.34%   -1.72%     
==========================================
  Files         179      270      +91     
  Lines        4613     8646    +4033     
  Branches      447      621     +174     
==========================================
+ Hits         3186     5823    +2637     
- Misses       1323     2662    +1339     
- Partials      104      161      +57     

Flag	Coverage Δ
ApplicationStatus	26.66% <ø> (ø)
ArangoDb	26.50% <ø> (ø)
Aws.S3	14.28% <ø> (ø)
Aws.SecretsManager	14.54% <ø> (ø)
Aws.Sns	14.77% <ø> (ø)
Aws.Sqs	15.28% <ø> (ø)
Aws.SystemsManager	14.54% <ø> (ø)
Azure.IoTHub	12.82% <ø> (ø)
AzureApplicationInsights	14.70% <ø> (ø)
AzureBlobStorage	25.17% <96.96%> (?)
AzureDigitalTwin	35.76% <ø> (ø)
AzureEventHubs	16.54% <90.00%> (?)
AzureFileStorage	25.17% <91.66%> (?)
AzureKeyVault	29.24% <100.00%> (+3.55%)	⬆️
AzureQueueStorage	25.17% <96.96%> (?)
AzureSearch	16.10% <ø> (ø)
AzureServiceBus	71.34% <98.67%> (-1.66%)	⬇️
AzureTableStorage	26.66% <97.22%> (?)
Consul	22.58% <ø> (ø)
CosmosDb	28.10% <96.87%> (-30.28%)	⬇️
Dapr	14.50% <ø> (?)
DocumentDb	14.64% <ø> (ø)
DynamoDb	12.12% <ø> (ø)
Elasticsearch	39.49% <ø> (ø)
EventStore	62.08% <ø> (ø)
EventStore.gRPC	25.51% <ø> (ø)
Gcp.CloudFirestore	12.10% <ø> (ø)
Gremlin	23.07% <ø> (ø)
Hangfire	10.97% <ø> (ø)
IbmMQ	30.76% <ø> (ø)
InfluxDB	15.00% <ø> (ø)
Kafka	22.03% <ø> (ø)
Kubernetes	41.54% <ø> (ø)
MongoDb	28.86% <ø> (ø)
MySql	33.33% <ø> (ø)
Nats	68.20% <ø> (ø)
Npgsql	28.73% <ø> (ø)
OpenIdConnectServer	39.28% <ø> (ø)
Oracle	60.60% <ø> (ø)
Prometheus.Metrics	29.80% <ø> (ø)
Publisher.ApplicationInsights	14.76% <ø> (ø)
Publisher.CloudWatch	19.02% <ø> (ø)
Publisher.Datadog	15.00% <ø> (ø)
Publisher.Prometheus	18.75% <ø> (ø)
Publisher.Seq	40.30% <ø> (ø)
RabbitMQ	47.89% <ø> (ø)
Redis	65.71% <ø> (-0.63%)	⬇️
SendGrid	11.92% <ø> (ø)
SignalR	24.22% <ø> (ø)
SqlServer	28.57% <ø> (ø)
Sqlite	26.38% <ø> (ø)
System	37.28% <ø> (ø)
Uris	61.23% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Files Changed	Coverage Δ
...mage/Extensions/IEndpointRouteBuilderExtensions.cs	0.00% <ø> (ø)
...ks.UI.Image/PushService/HealthChecksPushService.cs	0.00% <ø> (ø)
...Data.Tables/AzureTableServiceHealthCheckOptions.cs	100.00% <ø> (ø)
....Secrets/AzureKeyVaultSecretsHealthCheckOptions.cs	75.00% <ø> (ø)
...torage.Blobs/AzureBlobStorageHealthCheckOptions.cs	100.00% <ø> (ø)
...e.Files.Shares/AzureFileShareHealthCheckOptions.cs	100.00% <ø> (ø)
...rage.Queues/AzureQueueStorageHealthCheckOptions.cs	100.00% <ø> (ø)
src/HealthChecks.AzureServiceBus/ClientCache.cs	19.04% <ø> (ø)
...Checks.CosmosDb/AzureCosmosDbHealthCheckOptions.cs	100.00% <ø> (ø)
.../Discovery/K8S/Extensions/IKubernetesExtensions.cs	0.00% <ø> (ø)
... and 27 more

... and 76 files with indirect coverage changes

[sungam3r]

@adamsitnik NugetPackageExplorer tool may be helpful for such investigations.