# Laravel Badge

> Free, open-source dynamic SVG badge service that shows which Laravel versions a Packagist package supports. Embed a compatibility badge in any Laravel package README in seconds — no manual updates needed when you release new versions.

Laravel Badge is the go-to tool for Laravel package authors who want to communicate which versions of Laravel their package supports. The badge reads live composer.json constraints from Packagist and automatically displays the correct supported versions.

## What it does

- Fetches live composer.json constraints directly from Packagist for any public PHP package
- Resolves complex Laravel version ranges (e.g. `^10.0 || ^11.0`) into a clear, human-readable label
- Returns a dynamic SVG badge at `https://laravel-badge.peterfox.me/badge/{vendor}/{package}`
- Supports packages that depend on `laravel/framework` or individual `illuminate/*` components
- Caches results for 24 hours; refreshes automatically when packages update on Packagist
- Three badge styles: default (with gradient), flat, and for-the-badge

## Usage

Add to your Laravel package `README.md`:

```markdown
![Laravel Compatibility](https://laravel-badge.peterfox.me/badge/{vendor}/{package})
```

Example for the `spatie/laravel-permission` package:

```markdown
![Laravel Compatibility](https://laravel-badge.peterfox.me/badge/spatie/laravel-permission)
```

### Badge styles

- Default: `https://laravel-badge.peterfox.me/badge/{vendor}/{package}`
- Flat: `https://laravel-badge.peterfox.me/badge/{vendor}/{package}?style=flat`
- For the Badge: `https://laravel-badge.peterfox.me/badge/{vendor}/{package}?style=for-the-badge`

## Links

- [Homepage](https://laravel-badge.peterfox.me)
- [Preview & Generator Tool](https://laravel-badge.peterfox.me/preview)
- [Source Code](https://github.com/peterfox/laravel-badge)
- [Full Documentation](https://laravel-badge.peterfox.me/llms-full.txt)