Standardize README with shield badges
marcduiker opened this issue · comments
-- Updated so all badges are links, added FOSSA license scan --
We want to update the README for all Dapr repos so they all include shield badges for YouTube, Discord, X/Twitter and ensure they are all in the same style. See: dapr/community#355
These are the shield badges for the dotnet-sdk repo.
Snippet to include in the README:
[](https://www.nuget.org/packages/Dapr.Client) [](https://www.nuget.org/packages/Dapr.Client) [](https://github.com/dapr/dotnet-sdk/actions/workflows/sdk_build.yml) [](https://codecov.io/gh/dapr/dotnet-sdk) [](https://github.com/dapr/dotnet-sdk/blob/master/LICENSE) [](https://app.fossa.com/projects/custom%2B162%2Fgithub.com%2Fdapr%2Fdotnet-sdk?ref=badge_shield&issueType=license) [](https://github.com/dapr/dotnet-sdk/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) [](http://bit.ly/dapr-discord) [](https://youtube.com/@daprdev) [](https://twitter.com/daprdev)
Contributing
- Comment
/assignon this issue if you want to self-assign this issue and update the README. - Don't forget to sign off your commit, for more details see Developer Certificate of Origin (DCO) in the docs.
Please label this as good first issue.
/assign
@marcduiker done
Thanks for adding the badges @m3nax!
Could you make another PR and add back the # Dapr SDK for .NET on the first line of the README, please? This has unintentionally been removed with your change :). See the diff: https://github.com/dapr/dotnet-sdk/pull/1284/files
@marcduiker fixed
Thanks @m3nax !
@marcduiker - just noticed that some of links aren't working or included as intended. The twitter badge for example only contains the image url and navigates to the badge image when clicked.
The others are: latest version, build and license
Fixed build badge:
@marcduiker - just noticed that some of links aren't working or included as intended. The twitter badge for example only contains the image url and navigates to the badge image when clicked. The others are: latest version, build and license
Thanks @mikeee! I'll update the issue, and re-open. You can use the formatted snippet in this issue @m3nax since I've updated that.