cal-heatmap/README.md

Cal-Heatmap is a javascript module to create calendar heatmap to visualize time series data

[![Cal-Heatmap logo](https://cal-heatmap.com/img/favicon.png)](https://cal-heatmap.com/img/favicon.png)

# Cal-HeatMap [![Coverage Status](https://coveralls.io/repos/wa0x6e/cal-heatmap/badge.svg?branch=master&service=github)](https://coveralls.io/github/wa0x6e/cal-heatmap?branch=master) [![npm version](https://badge.fury.io/js/cal-heatmap.svg)](https://badge.fury.io/js/cal-heatmap) [![node](https://github.com/wa0x6e/cal-heatmap/actions/workflows/test.yml/badge.svg?branch=master)](https://github.com/wa0x6e/cal-heatmap/actions/workflows/test.yml) [![node](https://github.com/wa0x6e/cal-heatmap/actions/workflows/lint.yml/badge.svg?branch=master)](https://github.com/wa0x6e/cal-heatmap/actions/workflows/lint.yml)

> Cal-Heatmap is a javascript charting library to create a time-series calendar heatmap

This library will help you to chart a calendar heatmap, like the _[Github contribution calendar](https://github.com/blog/1360-introducing-contributions)_ appearing on each github user's page, but with more features like:

- 🔀 animated date navigation
- ⏳ time interval customisation
- 🗓️ full controls on the layout/UI
- 🌐 locale and timezone support
- ⚡ plugins system
- 🖥️ broad browsers support
- 🔚 right-to-left support
- ♾️ and many more...

![Github like Calendar Heatmap example](https://cal-heatmap.com/examples/1.png)
![Year/Day linear scale with legend Calendar Heatmap example](https://cal-heatmap.com/examples/2.png)
![Year/Day threshold scale with legend Calendar Heatmap example](https://cal-heatmap.com/examples/3.png)
![Month/Day alternate layout Calendar Heatmap example](https://cal-heatmap.com/examples/4.png)
![Month/Day weekdays only Calendar Heatmap example](https://cal-heatmap.com/examples/5.png)

See [documentation website](http://cal-heatmap.com) for full documentation and more examples.

## License

Cal-Heatmap is licensed under a [MIT License](./LICENSE).