Skip to content
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.

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

Standardize README with shield badges #594

Open
marcduiker opened this issue May 8, 2024 · 1 comment
Open

Standardize README with shield badges #594

marcduiker opened this issue May 8, 2024 · 1 comment
Assignees
Labels
good first issue Good for newcomers

Comments

@marcduiker
Copy link
Contributor

marcduiker commented May 8, 2024

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 js-sdk repo.

NPM Version NPM Downloads GitHub Actions Workflow Status codecov GitHub License GitHub issue custom search in repo Discord YouTube Channel Views X (formerly Twitter) Follow

Snippet to include in the README (the existing HTML can be replaced with this):

[![NPM Version](https://img.shields.io/npm/v/%40dapr%2Fdapr?style=flat&logo=npm&label=Latest%20version)](https://www.npmjs.com/package/@dapr/dapr) [![NPM Downloads](https://img.shields.io/npm/dy/%40dapr%2Fdapr?style=flat&logo=npm&label=Downloads)](https://www.npmjs.com/package/@dapr/dapr) [![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/dapr/js-sdk/.github%2Fworkflows%2Fbuild.yml?branch=main&label=Build&logo=github)](https://github.com/dapr/js-sdk/actions/workflows/build.yml) [![codecov](https://codecov.io/gh/dapr/js-sdk/branch/main/graph/badge.svg)](https://codecov.io/gh/dapr/js-sdk) [![GitHub License](https://img.shields.io/github/license/dapr/js-sdk?style=flat&label=License&logo=github)](https://github.com/dapr/js-sdk/blob/main/LICENSE) [![GitHub issue custom search in repo](https://img.shields.io/github/issues-search/dapr/js-sdk?query=type%3Aissue%20is%3Aopen%20label%3A%22good%20first%20issue%22&label=Good%20first%20issues&style=flat&logo=github)](https://github.com/dapr/js-sdk/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) [![Discord](https://img.shields.io/discord/778680217417809931?label=Discord&style=flat&logo=discord)](http://bit.ly/dapr-discord) [![YouTube Channel Views](https://img.shields.io/youtube/channel/views/UCtpSQ9BLB_3EXdWAUQYwnRA?style=flat&label=YouTube%20views&logo=youtube)](https://youtube.com/@daprdev) [![X (formerly Twitter) Follow](https://img.shields.io/twitter/follow/daprdev?logo=x&style=flat)](https://twitter.com/daprdev)

Contributing

Please label this as good first issue.

@shubham1172 shubham1172 added the good first issue Good for newcomers label May 8, 2024
@MO2k4 MO2k4 removed their assignment May 17, 2024
@RafaelJCamara
Copy link
Contributor

/assign

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants