Skip to content

ikramagix/gem_badge

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

28 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

GEM_BADGE

GEM_BADGE is a lightweight tool that allows you to showcase the download count of your Ruby gem directly on your GitHub README. By leveraging dynamic Shields.io badges, GEM_BADGE provides a quick and easy way to visually represent your gem's popularity.

Features

  • Fetches total download counts from RubyGems.org.
  • Generates a dynamic badge compatible with Shields.io.
  • Simple and intuitive setup for any Ruby gem.

Usage

  1. Deploy GEM_BADGE on your preferred platform (e.g., Render, Railway).
  2. Replace <gem_name> in the badge URL with your gem's name:
    ![Downloads](https://gem-badge-h3lg.onrender.com/downloads/<gem_name>)
  3. Add the badge to your GitHub README to display the download count.

Example

For my gem named faussaire, the badge URL would look like this:

![Downloads](https://img.shields.io/endpoint?url=https://gem-badge-h3lg.onrender.com/downloads/faussaire)

This would render as:
Faussaire Badge

Tip

The badge preview may not appear immediately because the host (Render) enters a dormant state on the free tier. If the badge does not load, try reloading the page or opening it in a new browser window. For better reliability, consider self-hosting.

License

GEM_BADGE is distributed under the CC BY-NC 4.0 License.

About

A lightweight tool that allows you to showcase the download count of your Ruby gem using shield.io.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •  

Languages