Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Adding GitHub Download Count Badge to Readme Mark Down

Tags:

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?

like image 437
joesan Avatar asked Aug 14 '17 10:08

joesan


People also ask

How do I add a badge to my GitHub repository?

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:

What is the GitHub stats badge?

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.

How do I reference a GitHub workflow in Markdown?

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.

How to boost the readability of your GitHub repository?

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.


1 Answers

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

like image 143
Dmitriy Budnik Avatar answered Sep 24 '22 15:09

Dmitriy Budnik