55 lines
1.4 KiB
Markdown
55 lines
1.4 KiB
Markdown
# 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:
|
|
|
|
```js
|
|
/* 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](http://www.w3.org/TR/SVG/types.html#DataTypeColor) 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`).
|
|
|
|
```js
|
|
"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](https://toolbelt.heroku.com/):
|
|
|
|
```bash
|
|
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.
|