140 lines
3.5 KiB
Markdown
140 lines
3.5 KiB
Markdown
# GitHub badges in SVG format
|
|
|
|
[](https://npmjs.org/package/gh-badges)
|
|
|
|
|
|
|
|
[](https://travis-ci.org/badges/gh-badges)
|
|
|
|
Make your own badges [here][badges]!
|
|
|
|
[badges]: <http://img.shields.io>
|
|
|
|
# Install the API
|
|
|
|
```bash
|
|
npm install gh-badges
|
|
```
|
|
|
|
```js
|
|
var badge = require('gh-badges');
|
|
badge({ text: [ "build", "passed" ], colorscheme: "green" },
|
|
function(svg, err) {
|
|
// svg is a String… of your badge.
|
|
});
|
|
```
|
|
|
|
# Use the CLI
|
|
|
|
```bash
|
|
npm install -g gh-badges
|
|
badge build passed :green .png > mybadge.png
|
|
# Stored a PNG version of your badge on disk.
|
|
```
|
|
|
|
# Start the Server
|
|
To run the server you will need the following executables on your Path:
|
|
- [PhantomJS](http://www.phantomjs.org/)
|
|
- [Cairo](http://cairographics.org/) (runtime dependency for Canvas)
|
|
|
|
On an OS X machine, [Homebrew](brew.sh) is a good package manager that will
|
|
allow you to install them.
|
|
|
|
```bash
|
|
git clone git@github.com:badges/shields
|
|
cd shields
|
|
npm install # You may need sudo for this.
|
|
sudo node server
|
|
```
|
|
|
|
The server uses port 80 by default, which requires `sudo` permissions.
|
|
There are two ways to provide an alternate port:
|
|
|
|
```bash
|
|
PORT=8080 node server
|
|
node server 8080
|
|
```
|
|
|
|
The root gets redirected to <http://shields.io>.
|
|
For testing purposes, you can go to `http://localhost/try.html`.
|
|
You should modify that file. The "real" root, `http://localhost/index.html`,
|
|
gets generated from the `try.html` file.
|
|
|
|
# Format
|
|
|
|
The format is the following:
|
|
|
|
```js
|
|
{
|
|
/* Textual information shown, in order. */
|
|
"text": [ "build", "passed" ],
|
|
"format": "svg", // Also supports "json".
|
|
"colorscheme": "green"
|
|
/* … Or… */
|
|
"colorA": "#555",
|
|
"colorB": "#4c1"
|
|
}
|
|
```
|
|
|
|
# Defaults
|
|
|
|
If you want to add a colorscheme, head to `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`).
|
|
|
|
[CSS/SVG color]: http://www.w3.org/TR/SVG/types.html#DataTypeColor
|
|
|
|
```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.
|
|
|
|
# Requirements
|
|
|
|
Because of the usage of the npm module [canvas][canvas-pkg] *you need* to have
|
|
**cairo** installed.
|
|
|
|
For more information check the [wiki][canvas-wiki] of the canvas project with
|
|
system-specific installation details.
|
|
|
|
[canvas-pkg]: https://npmjs.org/package/canvas
|
|
[canvas-wiki]: https://github.com/LearnBoost/node-canvas/wiki/_pages
|
|
|
|
# Making your Heroku badge server
|
|
|
|
Once you have installed the [Heroku Toolbelt][]:
|
|
|
|
[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
|
|
```
|
|
|
|
# Links
|
|
|
|
See <https://github.com/h5bp/lazyweb-requests/issues/150> for a story of the
|
|
project's inception.
|
|
|
|
This is also available as a gem `badgerbadgerbadger`, [code here][gem].
|
|
|
|
[gem]: https://github.com/badges/badgerbadgerbadger
|
|
|
|
# License
|
|
|
|
All work here is licensed CC0.
|