jaunesarmiento/favis-ci

Continuous Integration in your Favicon

Favis CI

Continuous Integration in your Favicon.

Introduction

Favis CI is a JavaScript plugin that modifies your favicon to include the latest build status of your project in Travis CI.

Usage

To use Favis-CI on your pages, just do:

var favis = new Favis('<username>/<repository>');

For example, to generate a Favis CI favicon for the Ember.js project, do:

var favis = new Favis('emberjs/ember.js');

Running Tests

What good is this plugin if it doesn't support tests right? To run the tests, you must first install Cairo which is a dependency of node-canvas. You'll be needing that because jsdom doesn't fully support the Canvas API (yet). Take note: Cairo is around ~100mb in size.

Follow these instructions on how to install node-canvas properly.

If libpng fails, try installing this binary.

If you got error error: mandatory image surface backend feature could not be enabled or Package cairo was not found in the pkg-config search path., the following command can resolve it:

$ export PKG_CONFIG_PATH=/usr/local/lib/pkgconfig

If you encounter errors regarding glib, it probably means you need to install it. To do this, run:

$ brew install glib

After the installation, run:

$ cd favis-ci # cd to Favis CI's root directory
$ npm install # then install dependencies

Then run:

$ npm test

Special Thanks

A warm thank you goes to Miroslav Magda for his favico.js where this idea came from. Also, Favis-CI based some of its code-base from it. Thanks a lot!

License

Favis CI is licensed under the MIT License. Copyright © and proudly crafted by Jaune Sarmiento, 2013.