Skip to content

Latest commit

 

History

History
29 lines (22 loc) · 1.17 KB

README.md

File metadata and controls

29 lines (22 loc) · 1.17 KB

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.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%3A%2F%2Fgem-badge.onrender.com%2Fdownloads%2Ffaussaire)

This would render as: Faussaire Badge

License

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