Shields badge specification, website and default API server
Go to file
2014-01-04 20:36:52 +01:00
img [badge] download + added color blue. 2014-01-04 17:13:15 +01:00
web Cache images: max-age + last-modified. 2014-01-04 20:36:52 +01:00
.buildpacks Node engine version information. Deployment files. 2014-01-03 19:25:49 +01:00
.gitignore Add SVGO to the pipeline 2014-01-02 18:25:34 +01:00
badge.js Use local verdana file if available. 2014-01-04 13:34:13 +01:00
colorscheme.json [badge] download + added color blue. 2014-01-04 17:13:15 +01:00
default-badges.json [badge] download + added color blue. 2014-01-04 17:13:15 +01:00
make.js Separate color scheme data in its own file. 2014-01-03 16:27:18 +01:00
Makefile make deploy: pushes master on the heroku instance. 2014-01-04 13:52:15 +01:00
package.json Node engine version information. Deployment files. 2014-01-03 19:25:49 +01:00
README.md Heroku instance creation information. 2014-01-04 14:03:45 +01:00
server.js Cache images: max-age + last-modified. 2014-01-04 20:36:52 +01:00
sheet.html [badge] download + added color blue. 2014-01-04 17:13:15 +01:00
template.svg template.svg: Remove redundant space 2014-01-03 19:12:07 +01:00

GitHub badges in SVG format

See https://github.com/h5bp/lazyweb-requests/issues/150.

Contribute

If you want to add a badge, you only need to modify badges.json.

The format is the following:

/* Unique name of your badge. */
"build-passed": {
  /* Textual information shown, in order. */
  "text": [ "build", "passed" ],
  "colorscheme": "green"
}

Color schemes are located in colorscheme.json. Each scheme has a name and a CSS/SVG color for the color used in the first box (for the first piece of text, field colorA) and for the one used in the second box (field colorB).

"green": {
  "colorB": "#4c1"
}

Both colorA and colorB have default values. Usually, the first box uses the same dark grey, so you can rely on that default value by not providing a "colorA" field (such as above).

You can also use the "colorA" and "colorB" fields directly in the badges if you don't want to make a color scheme for it. In that case, remove the "colorscheme" field altogether.

Making your Heroku badge server

Once you have installed the Heroku Toolbelt:

heroku login
heroku create your-app-name
heroku config:set BUILDPACK_URL=https://github.com/mojodna/heroku-buildpack-multi.git#build-env
cp /path/to/Verdana.ttf .
make deploy
heroku open

License

All work here is licensed CC0.