Skip to content

Commit

Permalink
Update readme with html instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
alex3165 committed Oct 24, 2020
1 parent 564c1aa commit 6af588f
Showing 1 changed file with 32 additions and 18 deletions.
50 changes: 32 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,27 +17,27 @@

### Proxy components (proxy between React and Mapbox API)

* ReactMapboxGL
* Layer & Feature
* property `symbol` displays a mapbox symbol.
* property `line` displays a lineString.
* property `fill` displays a polygon.
* property `circle` displays a mapbox circle.
* property `raster` displays a mapbox raster tiles.
* property `fill-extrusion` displays a layer with extruded buildings.
* property `background` displays a mapbox background layer.
* property `heatmap` displays a mapbox heatmap layer.
* Source
* GeoJSONLayer
- ReactMapboxGL
- Layer & Feature
- property `symbol` displays a mapbox symbol.
- property `line` displays a lineString.
- property `fill` displays a polygon.
- property `circle` displays a mapbox circle.
- property `raster` displays a mapbox raster tiles.
- property `fill-extrusion` displays a layer with extruded buildings.
- property `background` displays a mapbox background layer.
- property `heatmap` displays a mapbox heatmap layer.
- Source
- GeoJSONLayer

### DOM components (normal React components)

* ZoomControl
* ScaleControl
* RotationControl
* Marker (Projected component)
* Popup (Projected component)
* Cluster
- ZoomControl
- ScaleControl
- RotationControl
- Marker (Projected component)
- Popup (Projected component)
- Cluster

## Getting Started

Expand All @@ -47,6 +47,20 @@ npm install react-mapbox-gl mapbox-gl --save

Example:

Adding the css in your index.html:

```html
<html>
<head>
...
<link
href="https://api.mapbox.com/mapbox-gl-js/v1.10.1/mapbox-gl.css"
rel="stylesheet"
/>
</head>
</html>
```

```jsx
// ES6
import ReactMapboxGl, { Layer, Feature } from 'react-mapbox-gl';
Expand Down

0 comments on commit 6af588f

Please sign in to comment.