-
-
Notifications
You must be signed in to change notification settings - Fork 688
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update docs to set a clear "we are a new project" stance (#12)
* Update trademarked phrases in docs Merge in work done on maps-gl * fix spacing * Remove trademark references in CONTRIBUTING.md But don't change dist/mapbox-gl.js and company, that would break compat * Update CHANGELOG.md Co-authored-by: Yuri Astrakhan <yuriastrakhan@gmail.com>
- Loading branch information
Showing
4 changed files
with
48 additions
and
47 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 |
---|---|---|
@@ -1,4 +1,4 @@ | ||
# Architecture of Mapbox GL JS | ||
# Architecture of MapLibre GL JS | ||
|
||
## `Map` and its subsystems | ||
|
||
|
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
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
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 |
---|---|---|
@@ -1,34 +1,33 @@ | ||
# Mapbox GL JS open-source fork | ||
|
||
**Mapbox GL JS** is a JavaScript library for interactive, customizable vector maps on the web. It takes map styles that conform to the | ||
[Mapbox Style Specification](https://docs.mapbox.com/mapbox-gl-js/style-spec/), applies them to vector tiles that | ||
conform to the [Mapbox Vector Tile Specification](https://github.com/mapbox/vector-tile-spec), and renders them using | ||
WebGL. | ||
|
||
Mapbox GL JS is part of the [cross-platform Mapbox GL ecosystem](https://www.mapbox.com/maps/), which also includes | ||
compatible native SDKs for applications on [Android](https://docs.mapbox.com/android/maps/overview/), | ||
[iOS](https://docs.mapbox.com/ios/maps/overview/), [macOS](http://mapbox.github.io/mapbox-gl-native/macos), | ||
[Qt](https://github.com/mapbox/mapbox-gl-native/tree/master/platform/qt), and [React Native](https://github.com/mapbox/react-native-mapbox-gl/). Mapbox provides building blocks to add location features like maps, search, and navigation into any experience you | ||
create. To get started with GL JS or any of our other building blocks, | ||
[sign up for a Mapbox account](https://www.mapbox.com/signup/). | ||
|
||
In addition to GL JS, this repository contains code, issues, and test fixtures that are common to both GL JS and the | ||
native SDKs. For code and issues specific to the native SDKs, see the | ||
[mapbox/mapbox-gl-native](https://github.com/mapbox/mapbox-gl-native/) repository. | ||
|
||
- [Getting started with Mapbox GL JS](https://docs.mapbox.com/mapbox-gl-js/overview/) | ||
- [Tutorials](https://docs.mapbox.com/help/tutorials/#web-apps) | ||
- [API documentation](https://docs.mapbox.com/mapbox-gl-js/api/) | ||
- [Examples](https://docs.mapbox.com/mapbox-gl-js/examples/) | ||
- [Style documentation](https://docs.mapbox.com/mapbox-gl-js/style-spec/) | ||
- [Open source styles](https://github.com/mapbox/mapbox-gl-styles) | ||
- [Contributor documentation](./CONTRIBUTING.md) | ||
|
||
[<img width="981" alt="Mapbox GL gallery" src="https://raw.githubusercontent.com/mapbox/mapbox-gl-js-docs/publisher-production/docs/pages/assets/gallery.png">](https://www.mapbox.com/gallery/) | ||
# MapLibre GL | ||
|
||
## License | ||
**MapLibre GL** is a community led fork derived from [mapbox-gl-js](https://github.com/mapbox/mapbox-gl-js) prior to their switch to a non-OSS license. | ||
|
||
[<img width="200" alt="MapLibre" src="https://user-images.githubusercontent.com/223277/101580282-7534f700-397e-11eb-8b58-687f52e2a8cf.png">](http://maplibre.org) | ||
|
||
### Migrating from mapbox-gl | ||
|
||
If you depend on mapbox-gl directly, simply replace `mapbox-gl` with `maplibre-gl` in `package.json`: | ||
```diff | ||
"dependencies": { | ||
- "mapbox-gl": "^1.13.0" | ||
+ "maplibre-gl": ">=1.13.0-rc.1" | ||
} | ||
``` | ||
|
||
If you use mapbox-gl via bindings (react, vue, etc), you may need to wait a little longer as we develop an easy migration path for each binding. Contributions welcome! | ||
|
||
### Getting Involved | ||
|
||
Mapbox GL JS is licensed under the [3-Clause BSD license](./LICENSE.txt). | ||
The licenses of its dependencies are tracked via [FOSSA](https://app.fossa.io/projects/git%2Bhttps%3A%2F%2Fgithub.com%2Fmapbox%2Fmapbox-gl-js): | ||
Join the #maplibre slack channel at OSMUS: get an invite at https://osmus-slack.herokuapp.com/ | ||
|
||
### Avoid Fragmentation | ||
|
||
If you depend on a free software alternative to `mapbox-gl-js`, please consider joining our effort! Anyone with a stake in a healthy community led fork is welcome to help us figure out our next steps. We welcome contributors and leaders! MapLibre GL already represents the combined efforts of a few early fork efforts, and we all benefit from "one project" rather than "our way". If you know of other forks, please reach out to them and direct them here. | ||
|
||
### Thank you Mapbox 🙏🏽 | ||
|
||
We'd like to acknowledge the amazing work Mapbox has contributed to open source. The open source community is sad to part ways with them, but we simultaneously feel grateful for everything they already contributed. `mapbox-gl-js` 1.x is an open source achievment which now lives on as `mapslibre-gl`. We're proud to develop on the shoulders of giants, thank you Mapbox 🙇🏽♀️ | ||
|
||
## License | ||
|
||
[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bhttps%3A%2F%2Fgithub.com%2Fmapbox%2Fmapbox-gl-js.svg?type=large)](https://app.fossa.io/projects/git%2Bhttps%3A%2F%2Fgithub.com%2Fmapbox%2Fmapbox-gl-js?ref=badge_large) | ||
MapLibre GL is licensed under the [3-Clause BSD license](./LICENSE.txt). |