Github Contributions on Canvas [![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Dependency Status][daviddm-image]][daviddm-url]

A tool for drawing a heat-map of Github contributions on HTML Canvas.

This module is used for drawing user contributions in this project.

Install

``sh
$ npm install github-contributions-canvas
`

Usage

`js
import { drawContributions } from "github-contributions-canvas";

drawContributions(canvasEl, {
data: contributionData,
username: "myusername",
themeName: "standard",
footerText: "Made by @sallar - github-contributions.now.sh"
});
`

Available Themes

The themes are defined in the src/themes.js file.
Currently the available themes are:

- standard
- halloween
- teal
- leftPad
- dracula
- blue
- panda
- sunny
- pink
- YlGnBu
- solarizedDark
- solarizedLight`

Data Format

This module accepts the output from sallar/github-contributions-api API. Check that project for more info.

License

Sallar Kaboli © MIT License

[npm-image]: https://badge.fury.io/js/github-contributions-canvas.svg
[npm-url]: https://npmjs.org/package/github-contributions-canvas
[travis-image]: https://travis-ci.com/sallar/github-contributions-canvas.svg?branch=master
[travis-url]: https://travis-ci.com/sallar/github-contributions-canvas
[daviddm-image]: https://david-dm.org/sallar/github-contributions-canvas.svg?theme=shields.io
[daviddm-url]: https://david-dm.org/sallar/github-contributions-canvas