Let me introduce you to render-status-badge - a lightweight Node.js tool that generates dynamic status badges for Render deployments using Shields.io and Render's API.

A screenshot of the render badges readme demo

Why You Need This

  • Instant Visibility: Know if your last deploy succeeded or failed at a glance. 
  • Professional Polish: Make your READMEs look pro with Shields.io badges. 
  • Zero Maintenance: Automatically updates using GitHub Actions. 
  • Multi-Project Ready: Use it across all your Render services.

How It Works in 3 Steps

1. Install the Package

npm install render-status-badge

or run it once without installing

npx render-status-badge

Configure Your Render Credentials

2. Create a .env file with your Render API key and service ID:

RENDER_API_KEY="your_api_key_here" 
RENDER_SERVICE_ID="srv-your-service-id"

Never commit .env to Git! Use GitHub Secrets for CI/CD._

3. Add the Badge to Your README

Run the tool to get your badge URL:

npx render-status-badge

Output is something like

https://img.shields.io/badge/Render-Live-brightgreen?logo=render&style=for-the-badge

Then paste the URL into your README.md:

![Render Status](https://img.shields.io/badge/Render-Live-brightgreen?logo=render&style=for-the-badge)

Automate It with GitHub Action (Optional)
For **real-time updates, add this workflow to your repo**

.github/workflows/update-badge.yml:

name: Update Render Status Badge 
on: 
 schedule: 
 - cron: '*/5 * * * *' # Update every 5 minutes 
 workflow_dispatch:
jobs: 
 update-badge: 
 runs-on: ubuntu-latest 
 steps: 
 - uses: actions/checkout@v4 
 - name: Generate Badge 
 env: 
 RENDER_API_KEY: ${{ secrets.RENDER_API_KEY }} 
 RENDER_SERVICE_ID: ${{ secrets.RENDER_SERVICE_ID }} 
 run: npx render-status-badge >> badge-url.txt 
 - name: Update README 
 run: | 
 sed -i "s|<! - RENDER_BADGE →.*|![Render Status]($(cat badge-url.txt))|" README.md 
 git commit -am "Update Render status badge" && git push

Customize Your Badge
Use Shields.io's parameters to tweak the style:
Render Status
Options

  • style: for-the-badge (default), flat-square, plastic
  • label: Custom text like "Deploy Status"
  • color: Override based on your theme

If you like the project please feel free to Contribute or Star the Project, it lives on GitHub: https://github.com/nia-cloud-official/render-status
I'd love your help!

  • ⭐ Star the repo to show support. 
  • 🐛 Report bugs via GitHub Issues. 
  • 💡 Suggest features and fixes or submit PRs.

Final Thoughts

Render is an amazing platform, and now it's got a little extra polish. Whether you're managing 1 service or 100, these badges will save you time and keep your team informed.
Go ahead - give your README the glow-up it deserves! ✨