Markdown README skeleton for an npm package with install, usage, API, contributing and license sections.
Shields.io Badge Generator
Runs locally
Use Shields.io Badge Generator
What it does
Set the label, message, colour and style, and the badge is drawn on this page the way shields.io draws it. Copy the Markdown or HTML snippet for a README; the snippet points to img.shields.io.
It runs entirely in your browser: nothing you enter is uploaded.
Example
A "phishing: reported" status badge
phishingLabel phishing, message reported, red, flat-square style: the preview is drawn the way img.shields.io draws it, and the Markdown, HTML and image URL snippets point to the same static badge.
FAQ
How close is the preview to the real badge?
The preview uses the layout, colours and Verdana width tables of shields.io's badge-maker 6.0.0, so for named and hex colours it matches the SVG that img.shields.io returns. Logos, the social style and dynamic badges with live numbers are not drawn here.
How are dashes, underscores and spaces written in the badge URL?
In a static badge path a dash is written as --, an underscore as __ and a space as _, and other characters are percent-encoded. The tool does this for you, so the label a-b_c becomes a--b__c.
Does this page contact shields.io?
No. The preview is drawn locally and nothing is requested while you edit. The snippet you copy points to img.shields.io, so the badge is loaded from shields.io wherever you paste it.