-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
31 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
[![@wq/map-gl][logo]][docs] | ||
|
||
**@wq/map-gl** is a plugin for [@wq/app] that provides integration with Mapbox GL for web, Android, and iOS. When used together with [@wq/map], @wq/map-gl can leverage the [wq configuration object][config] to generate interactive maps for pages rendered via @wq/app. The generated maps can automatically download and display GeoJSON data rendered by [wq.db's REST API][wq.db] or any third party service. | ||
|
||
The actual bindings for each environment are provided by [@wq/map-gl-web][installation] and [@wq/map-gl-native][installation], either or both of which should be installed in addition to @wq/map-gl. | ||
|
||
### [Documentation][docs] | ||
|
||
[**Installation**][installation] | ||
• | ||
[**API**][api] | ||
• | ||
[Configuration][configuration] | ||
• | ||
[Components][components] | ||
|
||
[logo]: https://wq.io/images/@wq/map-gl.svg | ||
[docs]: https://wq.io/@wq/map-gl | ||
[installation]: https://wq.io/@wq/map-gl#installation | ||
[api]: https://wq.io/@wq/map-gl#api | ||
[configuration]: https://wq.io/@wq/map-gl#configuration | ||
[components]: https://wq.io/@wq/map-gl#components | ||
|
||
[@wq/app]: https://wq.io/@wq/app | ||
[@wq/map]: https://wq.io/@wq/map | ||
[config]: https://wq.io/config | ||
[wq.db]: https://wq.io/wq.db/ | ||
|
||
[Mapbox GL JS]: https://docs.mapbox.com/mapbox-gl-js/ | ||
[mapbox-android]: https://docs.mapbox.com/android/maps/overview/ | ||
[mapbox-ios]: https://docs.mapbox.com/ios-sdk/maps/overview/ |