diff --git a/.npmignore b/.npmignore new file mode 100644 index 00000000..fabad23f --- /dev/null +++ b/.npmignore @@ -0,0 +1 @@ +heatmap-example.gif diff --git a/README.md b/README.md index a68ed574..6c85bf8d 100644 --- a/README.md +++ b/README.md @@ -11,23 +11,13 @@ be Mapbox APIs that haven't yet been exposed. ## Overview -react-map-gl provides an `overlay` API so you can add visualization overlays. - -Supported Overlays: - -1. ChoroplethOverlay -2. ScatterplotOverlay -3. DraggablePointsOverlay -4. SVGOverlay -5. CanvasOverlay - -## Installation +### Installation ``` npm install react-map-gl --save ``` -## Usage +### Usage ````js @@ -47,6 +43,34 @@ npm install react-map-gl --save ]) ```` +Other built in overlays include: + +1. ChoroplethOverlay +2. ScatterplotOverlay +3. DraggablePointsOverlay +4. SVGOverlay +5. CanvasOverlay + +Other third party overlays can also be created. For example, the +[heatmap-overlay](https://github.com/vicapow/react-map-gl-heatmap-overlay) uses +[webgl-heatmap](https://github.com/vicapow/webgl-heatmap) to create geographic +heatmaps. + +![heatmap-example.gif]() + +Example usage: + +````js +var HeatmapOverlay = require('react-map-gl-heatmap-overlay'); +var cities = require('example-cities'); +// ... + render: function render() { + return + + ; + } +```` + ### ImmutableJS all the things diff --git a/heatmap-example.gif b/heatmap-example.gif new file mode 100644 index 00000000..465bc688 Binary files /dev/null and b/heatmap-example.gif differ