VibeMon
Get started
badge

Add a VibeMon badge to your README

A live SVG badge showing your coding streak and activity totals. Paste one line into your README — it updates once per hour, renders inside GitHub / GitLab / Bitbucket, and quietly credits VibeMon with a backlink.

Zero setup · 1 minute · Free

Section 01 — Preview

What it looks like

The value segment shows your current XP count, current streak, and stage name. It auto-updates once per hour (via edge cache) and gracefully shows Not Found if the handle is invalid.

Section 02 — Copy-paste

Grab the snippet

Markdown (GitHub, GitLab, Bitbucket, Obsidian)

markdown
[![VibeMon](https://vibemon.dev/api/badge/YOUR_HANDLE)](https://vibemon.dev/u/YOUR_HANDLE)

Clickable image — recommended for README files. Replace YOUR_HANDLE with your actual VibeMon handle (the part after /u/ on your profile URL).

Section 03 — Where to put it

Example READMEs

At the top — most visible

README.md
# Awesome Project

[![VibeMon](https://vibemon.dev/api/badge/YOUR_HANDLE)](https://vibemon.dev/u/YOUR_HANDLE)

A library for doing cool stuff with data.

With other badges — shields row

README.md
# Awesome Project

![Build](https://img.shields.io/github/actions/workflow/status/you/repo/ci.yml)
![npm](https://img.shields.io/npm/v/your-package)
[![VibeMon](https://vibemon.dev/api/badge/YOUR_HANDLE)](https://vibemon.dev/u/YOUR_HANDLE)

In a profile README (github.com/YOU/YOU)

README.md
### 👋 Hi, I'm YOU

I vibe code.

[![VibeMon](https://vibemon.dev/api/badge/YOUR_HANDLE)](https://vibemon.dev/u/YOUR_HANDLE)

Working on: cool stuff with data.

Section 04 — How it works

Technical details

Endpoint: GET https://vibemon.dev/api/badge/[handle]

Format: SVG (image/svg+xml).

Cache: 1 hour (public, s-maxage=3600). GitHub's Camo proxy caches additionally, so the badge may lag real values by up to a few hours.

Errors: Returns VibeMon | Not Found for unknown handles and VibeMon | Setup Required when the backend is unconfigured. On an unexpected server error it returns an HTTP 500 with a fallback SVG body — most renderers (GitHub included) will briefly show a broken-image icon in that case rather than silently hiding the badge.

Dimensions: Auto-width, 20px height. Renders cleanly next to other shields.io badges.

Section 05 — Privacy

What the badge exposes

The badge shows your total XP, current streak, current stage name, and — once you've coded enough for VibeMon to classify you — a short coder-type code (e.g. BLD-N). Your handle is not printed on the badge itself, and neither is anything derived from event content: no email, no IP, no agent-specific event data, no project names.

There is currently no way to make a public profile private — if your handle exists, /u/<handle> and this badge are both reachable by anyone who has the URL. If that matters to you, avoid setting a handle, or email admin@streamize.net.

Related