https://github.com/ikramagix/gem_badge

A lightweight tool that allows you to showcase the download count of your Ruby gem using shield.io!
https://github.com/ikramagix/gem_badge

badge download downloads-count gem gembadge python readme rubygem rubygems shieldsio shieldsio-badges

Last synced: over 1 year ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/ikramagix/gem_badge
• Owner: ikramagix
• License: other
• Created: 2025-01-11T11:41:32.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2025-02-20T21:39:33.000Z (over 1 year ago)
• Last Synced: 2025-02-20T22:29:36.355Z (over 1 year ago)
• Topics: badge, download, downloads-count, gem, gembadge, python, readme, rubygem, rubygems, shieldsio, shieldsio-badges
• Language: Python
• Homepage: https://gem-badge.onrender.com
• Size: 11.7 KB
• Stars: 6
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

          
# 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](https://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 `` in the badge URL with your gem's name:

   ```markdown

   ![Downloads](https://gem-badge.onrender.com/downloads/)

   ```

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:

```markdown

![Downloads](https://img.shields.io/endpoint?url=https%3A%2F%2Fgem-badge.onrender.com%2Fdownloads%2Ffaussaire)

```

This would render as:




![Faussaire Badge](https://img.shields.io/endpoint?url=https%3A%2F%2Fgem-badge.onrender.com%2Fdownloads%2Ffaussaire)




> [!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](LICENSE.txt).