56 lines
1.9 KiB
Markdown
56 lines
1.9 KiB
Markdown
|
# heatmap.js
|
||
|
|
Dynamic Heatmaps for the Web.
|
||
|
|
|
||
|
|
[<img src="http://www.patrick-wied.at/static/heatmapjs/assets/img/heatmapjs-examples-docs-banner.jpg" width="100%">](http://www.patrick-wied.at/static/heatmapjs/?utm_source=gh "View the heatmap.js website with usage examples, showcases, best practises, plugins ( googlemaps heatmap, leaflet) and more.")
|
||
|
|
|
||
|
|
## How to get started
|
||
|
|
|
||
|
|
The fastest way to get started is to install heatmap.js with bower. Just run the following command:
|
||
|
|
|
||
|
|
`bower install heatmap.js-amd`
|
||
|
|
|
||
|
|
This will download the latest working version of heatmap.js and put it in your bower_components folder.
|
||
|
|
|
||
|
|
Alternatively you could just download [the latest release](https://github.com/pa7/heatmap.js/releases) from github and unzip it.
|
||
|
|
|
||
|
|
|
||
|
|
The file you're ultimately looking for is **heatmap.js** or **heatmap.min.js**
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
heatmap.js is also hosted on npm:
|
||
|
|
|
||
|
|
`npm install heatmap.js`
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
### How to run the local examples
|
||
|
|
|
||
|
|
Start a webserver (e.g. python SimpleHTTPServer from the project directory root):
|
||
|
|
|
||
|
|
`python -m SimpleHTTPServer 1337 &`
|
||
|
|
|
||
|
|
Then browse to
|
||
|
|
|
||
|
|
`http://localhost:1337/examples/`
|
||
|
|
|
||
|
|
|
||
|
|
## Get involved
|
||
|
|
|
||
|
|
Please have a look at the [contribution guidelines](CONTRIBUTE.md) before submitting contributions.
|
||
|
|
|
||
|
|
**Disclaimer**: PRs can take time to receive feedback or be merged ( I'm only one person with very little time ) but I'm trying to get back to everyone eventually
|
||
|
|
|
||
|
|
## Questions?
|
||
|
|
|
||
|
|
In order to keep technical questions in a central place where other people can learn from it, the best thing you can do is [post your question to stackoverflow with the tag **heatmap.js**.](http://stackoverflow.com/questions/ask?tags=heatmap.js)
|
||
|
|
|
||
|
|
If you do have a very specific question (or need commercial support) don't hesitate to contact me directly [via email](mailto:heatmap-q@patrick-wied.at).
|
||
|
|
|
||
|
|
|
||
|
|
## Mailing list
|
||
|
|
|
||
|
|
Want to receive the latest updates and news about heatmap.js?
|
||
|
|
|
||
|
|
There is a [mailing list](http://eepurl.com/0mmV5). No spam, just news and important updates.
|