Pixel-perfect   Retina-ready   Fast   Consistent   Hackable   No tracking


Version

Mozilla Add-on:/amo/v/:addonId
APM:/apm/v/:packageName
Arch Linux package:/archlinux/v/:repository/:architecture/:packageName
AUR version:/aur/version/:packageName
Bintray:/bintray/v/:subject/:repo/:packageName
Bower:/bower/v/:packageName
Bower Pre Release:/bower/vpre/:packageName
Cdnjs:/cdnjs/v/:library
Chocolatey:/chocolatey/v/:packageName
Chocolatey (with prereleases):/chocolatey/vpre/:packageName
Chrome Web Store:/chrome-web-store/v/:storeId
ClojarsVersionRelease:/clojars/v/:clojar+
ClojarsVersionSnapshot:/clojars/vpre/:clojar+
Cocoapods:/cocoapods/v/:spec
Conda:/conda/v/:channel/:package
Conda (channel only):/conda/vn/:channel/:package
Chef cookbook:/cookbook/v/:cookbook
CPAN:/cpan/v/:packageName
CRAN/METACRAN:/cran/v/:packageName
Crates.io:/crates/v/:crate
CTAN:/ctan/v/:library
Debian package:/debian/v/:packageName/:distribution?
DUB:/dub/v/:packageName
Eclipse Marketplace:/eclipse-marketplace/v/:name
Elm package:/elm-package/v/:user/:packageName
F-Droid:/f-droid/v/:appId
F-Droid (explicit metadata format):/f-droid/v/:appId?metadata_format=yml
Fedora package:/fedora/v/:packageName/:branch?
Gem:/gem/v/:gem
GitHub manifest version:/github/manifest-json/v/:user/:repo
GitHub manifest version:/github/manifest-json/v/:user/:repo/:branch
GitHub package.json version:/github/package-json/v/:user/:repo
GitHub package.json version (branch):/github/package-json/v/:user/:repo/:branch
GitHub release:/github/:variant/:user/:repo
GitHub tag (latest SemVer):/github/tag/:user/:repo
GitHub tag (latest SemVer pre-release):/github/tag-pre/:user/:repo
GitHub tag (latest by date):/github/tag-date/:user/:repo
Hackage:/hackage/v/:packageName
Hex.pm:/hexpm/v/:packageName
homebrew:/homebrew/v/:formula
iTunes App Store:/itunes/v/:bundleId
Jenkins Plugins:/jenkins/plugin/v/:plugin
JetBrains IntelliJ Plugins:/jetbrains/plugin/v/:pluginId
JitPack:/jitpack/v/:vcs/:user/:repo
LuaRocks:/luarocks/v/:user/:moduleName/:version?
Maven Central:/maven-central/v/:groupId/:artifactId
Maven Central with version prefix filter:/maven-central/v/:groupId/:artifactId/:versionPrefix
Maven metadata URL:/maven-metadata/v/:protocol/:hostAndPath+
MyGet:/myget/:feed/v/:packageName
MyGet (with prereleases):/myget/:feed/vpre/:packageName
MyGet tenant:/:tenant.myget/:feed/v/:packageName
Sonatype Nexus (Releases):/nexus/r/:scheme/:hostAndPath/:groupId/:artifactId
Sonatype Nexus (Snapshots):/nexus/s/:scheme/:hostAndPath/:groupId/:artifactId
Sonatype Nexus (Repository):/nexus/:repo/:scheme/:hostAndPath/:groupId/:artifactId
Sonatype Nexus (Query Options):/nexus/:repo/:scheme/:hostAndPath/:groupId/:artifactId/:queryOpt
npm:/npm/v/:packageName
npm (scoped):/npm/v/:scope/:packageName
npm (tag):/npm/v/:packageName/:tag
npm (custom registry):/npm/v/:packageName/:tag?registry_uri=https%3A%2F%2Fregistry.npmjs.com
npm (scoped with tag):/npm/v/:scope/:packageName/:tag
Nuget:/nuget/v/:packageName
Nuget (with prereleases):/nuget/vpre/:packageName
Packagist Version:/packagist/v/:user/:repo
Packagist Pre Release Version:/packagist/vpre/:user/:repo
PowerShell Gallery:/powershellgallery/v/:packageName
PowerShell Gallery (with prereleases):/powershellgallery/vpre/:packageName
Pub:/pub/v/:packageName
Pub:/pub/vpre/:packageName
Puppet Forge version:/puppetforge/v/:user/:moduleName
PyPI:/pypi/v/:packageName
JetBrains ReSharper plugins:/resharper/v/:packageName
JetBrains ReSharper plugins (with prereleases):/resharper/vpre/:packageName
Spack:/spack/v/:packageName
Spiget Version:/spiget/version/:resourceId
Ubuntu package:/ubuntu/v/:packageName/:series?
Vaadin Directory:/vaadin-directory/v/:packageName
Visual Studio Marketplace Version:/visual-studio-marketplace/v/:extensionId
WordPress Theme Version:/wordpress/theme/v/:slug
WordPress Plugin Version:/wordpress/plugin/v/:slug

Your Badge

Static


Using dash "-" separator

https://img.shields.io/badge/<LABEL>-<MESSAGE>-<COLOR>

Dashes --- Dash
Underscores ___ Underscore
_ or Space    Space

Using query string parameters

https://img.shields.io/static/v1?label=<LABEL>&message=<MESSAGE>&color=<COLOR>

Colors

brightgreengreenyellowgreenyelloworangeredbluelightgrey
successimportantcriticalinformationalinactive
bluevioletff69b49cf

Endpoint

https://img.shields.io/endpoint?url=<URL>&style<STYLE>

Create badges from your own JSON endpoint.

Dynamic

https://img.shields.io/badge/dynamic/json?url=<URL>&label=<LABEL>&query=<$.DATA.SUBDATA>&color=<COLOR>&prefix=<PREFIX>&suffix=<SUFFIX>

https://img.shields.io/badge/dynamic/xml?url=<URL>&label=<LABEL>&query=<//data/subdata>&color=<COLOR>&prefix=<PREFIX>&suffix=<SUFFIX>

https://img.shields.io/badge/dynamic/yaml?url=<URL>&label=<LABEL>&query=<$.DATA.SUBDATA>&color=<COLOR>&prefix=<PREFIX>&suffix=<SUFFIX>


Styles

The following styles are available. Flat is the default. Examples are shown with an optional logo:

?style=plastic&logo=appveyorplastic
?style=flat&logo=appveyorflat
?style=flat-square&logo=appveyorflat-square
?style=for-the-badge&logo=appveyorfor-the-badge
?style=social&logo=appveyorsocial

Here are a few other parameters you can use: (connecting several with "&" is possible)

?label=healthinessesOverride the default left-hand-side text (URL-Encoding needed for spaces or special characters!)
?logo=appveyorInsert one of the named logos from (bitcoin, dependabot, discord, gitlab, npm, paypal, serverfault, stackexchange, superuser, telegram, travis) or simple-icons. Simple-icons are referenced using names as they appear on the simple-icons site. If the name includes spaces, replace them with dashes (e.g: ?logo=visual-studio-code)
?logo=data:image/png;base64,…Insert custom logo image (≥ 14px high)
?logoColor=violetSet the color of the logo (hex, rgb, rgba, hsl, hsla and css named colors supported)
?logoWidth=40Set the horizontal space to give to the logo
?link=http://left&link=http://rightSpecify what clicking on the left/right of a badge should do (esp. for social badge style)
?labelColor=abcdefSet background of the left part (hex, rgb, rgba, hsl, hsla and css named colors supported). The legacy name "colorA" is also supported.
?color=fedcbaSet background of the right part (hex, rgb, rgba, hsl, hsla and css named colors supported). The legacy name "colorB" is also supported.
?cacheSeconds=3600Set the HTTP cache lifetime (rules are applied to infer a default value on a per-badge basis, any values specified below the default will be ignored). The legacy name "maxAge" is also supported.

We support .svg and .json. The default is.svg, which can be omitted from the URL.

While we highly recommend using SVG, we also support .pngfor use cases where SVG will not work. These requests should be made to our raster server https://raster.shields.io. For example, the raster equivalent ofhttps://img.shields.io/v/npm/express ishttps://raster.shields.io/v/npm/express. For backward compatibility, the badge server will redirect .png badges to the raster server.

Like This?

Have an idea for an awesome new badge?
Tell us about it and we might bring it to you!

StatusMetricsGitHub