diff --git a/README.md b/README.md index 3e888256..2373bad7 100644 --- a/README.md +++ b/README.md @@ -11,10 +11,7 @@

react-map-gl | Docs

-react-map-gl is a suite of [React](http://facebook.github.io/react/) components for -[Mapbox GL JS](https://github.com/mapbox/mapbox-gl-js). - -Mapbox GL JS is an awesome library for making modern web maps. It is beautiful, efficient (WebGL-powered), and fully open source. You may load map data from Mapbox's own service, which is free until a certain level of traffic is exceeded; or you can create and host your own map data using one of the many [open source tools](https://github.com/mapbox/awesome-vector-tiles). +`react-map-gl` is a suite of [React](http://facebook.github.io/react/) components designed to provide a React API for [Mapbox GL JS](https://github.com/mapbox/mapbox-gl-js)-compatible libraries. More information in the online documentation. See our [Design Philosophy](docs/README.md#design-philosophy). diff --git a/docs/README.md b/docs/README.md index 242b898e..2459bb0f 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,9 +1,18 @@ # Introduction react-map-gl is a suite of [React](http://facebook.github.io/react/) components for -[Mapbox GL JS](https://github.com/mapbox/mapbox-gl-js). +Mapbox GL JS-compatible libraries. -Mapbox GL JS is an awesome library for making modern web maps. It is beautiful, efficient (WebGL-powered), and fully open source. You may load map data from Mapbox's own service, which is free until a certain level of traffic is exceeded; or you can create and host your own map data using one of the many [open source tools](https://github.com/mapbox/awesome-vector-tiles). +| Library | Description | +| --- | --- | +| [MapLibre](https://github.com/MapLibre/maplibre-gl-js) | An open fork of mapbox-gl-js v1, that can be used without a mapbox token. | +| [Mapbox GL JS v1](https://github.com/mapbox/mapbox-gl-js) | The previous version of mapbox GL JS. This version is free open source and can be used with non-mapbox basemaps without a mapbox token. | +| [Mapbox GL JS v2](https://github.com/mapbox/mapbox-gl-js) | The latest version of Mapbox GL JS. Note that version 2 is not free open source, and a mapbox token is required and billable events are generated even if you do not use mapbox hosted basemaps. | +| Other mapbox-gl-js forks | It may be possible to use react-map-gl with other mapbox forks, but this is not a supported use case. Minor PRs to enable other forks to be used may be accepted. | + +For basemaps: +- You can load map data from Mapbox's own service. +- You can create and host your own map data using one of the many [open source tools](https://github.com/mapbox/awesome-vector-tiles). New to react-map-gl? [Get Started](/docs/get-started/get-started.md)