I would like to add a badge that counts the total number of downloads that happen for one of my projects that I have on GitHub. I came across this page that has all the image shields
https://shields.io/
![Github Releases](https://img.shields.io/github/downloads/atom/atom/latest/total.svg?style=plastic)
Any ideas on how I could add this to my project in GitHub?
All you need to do is open the GitHub link and fill your repository information, as shown in the image below: In case your repository is for a Ruby gem or other libraries, such as an NPM library, you can add a badge with the version of the package by using the following link. The most interesting options are:
The GitHub Stats badge demonstrates the total Stars, Commits, Pull Requests, Issues, and Contributions of your GitHub repository. Stars: Users save GitHub repositories (like bookmarking). This indicates that the user is interested and wishes stay up-to-date with the saved repository. However, a starred repository cannot be edited.
You reference the workflow by the name of your workflow file. This Markdown example adds a status badge for a workflow with the file path .github/workflows/main.yml. The OWNER of the repository is the github organization and the REPOSITORY name is docs.
GitHub Badges can boost the readability of a repository by providing users with a fast way to capture the repository metrics. Badges can be embedded in your README.md to clarify the importance and necessity of your project to other developers. As a result, readers get a really fast idea of the repository by checking the attached badges.
You have to insert it as an image into your README
. If your README
is markdown (README.md) that should be like:
Syntax:
[![Github All Releases](https://img.shields.io/github/downloads/<-- User Name-->/<-- Your Repo Name-->/total.svg)]()
Example
[![Github All Releases](https://img.shields.io/github/downloads/atom/atom/total.svg)]()
If you click on the badge on shields.io you can copy-paste markdown syntax you need to insert into README.md
If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!
Donate Us With