Skip to content

Commit

Permalink
docs: update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
stepankuzmin committed Aug 14, 2018
1 parent 8591e3d commit 4ff91f6
Showing 1 changed file with 11 additions and 6 deletions.
17 changes: 11 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
# Urbica React Mapbox GL JS

![npm](https://img.shields.io/npm/v/@urbica/react-map-gl.svg?style=popout)
![CircleCI](https://img.shields.io/circleci/project/github/urbica/react-map-gl.svg?style=popout)

React Component for Mapbox GL JS.

[Examples](https://urbica.github.io/react-map-gl/).
Expand All @@ -16,16 +19,18 @@ This package is heavily inspired by [uber/react-map-gl](https://github.com/uber/

npm install --save mapbox-gl [email protected] @urbica/react-map-gl

You may also want to install `supercluster` package for `Cluster` component.

## List of React components

`@urbica/react-map-gl` provides a set of components:

- MapGL
- Source
- Layer
- Cluster
- Popup
- Marker
- [MapGL](https://urbica.github.io/react-map-gl/#mapgl)
- [Source](https://urbica.github.io/react-map-gl/#source)
- [Layer](https://urbica.github.io/react-map-gl/#layer)
- [Cluster](https://urbica.github.io/react-map-gl/#cluster)
- [Popup](https://urbica.github.io/react-map-gl/#popup)
- [Marker](https://urbica.github.io/react-map-gl/#marker)

## Examples

Expand Down

0 comments on commit 4ff91f6

Please sign in to comment.