BMAD Badge

Dynamic version badge for projects using BMAD METHOD

BMAD Badge Example Example badge

Usage

Add this to your README.md:

[![BMAD](https://bmad-badge.vercel.app/{owner}/{repo}.svg)](https://github.com/bmad-code-org/BMAD-METHOD)

Replace {owner} and {repo} with your GitHub username and repository name.

Try It

Options

Parameter Description Default
style Badge style: flat or flat-square flat
color Custom color (hex without #) Auto (based on version)
label Custom label text BMAD

Examples

<!-- Flat style (default) -->
[![BMAD](https://bmad-badge.vercel.app/nick/my-project.svg)]

<!-- Flat-square style -->
[![BMAD](https://bmad-badge.vercel.app/nick/my-project.svg?style=flat-square)]

<!-- Custom color -->
[![BMAD](https://bmad-badge.vercel.app/nick/my-project.svg?color=ff69b4)]

Color Rules

Version Type Color
Stable (e.g., 1.0.0) Green
Beta (e.g., 1.0.0-Beta.1) Blue
Alpha (e.g., 1.0.0-Alpha.1) Orange
Not installed Gray

How It Works

  1. The badge service queries the GitHub API for your repository
  2. It looks for _bmad/_config/manifest.yaml
  3. Extracts the version from installation.version
  4. Generates an SVG badge with appropriate color