Skip to content

Commit c71b6dc

Browse files
authored
Prepare to update the readme when we release version 2.0. (#611)
1 parent 91df0f0 commit c71b6dc

1 file changed

Lines changed: 28 additions & 5 deletions

File tree

README.md

Lines changed: 28 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,29 +5,52 @@
55
### Migrating from mapbox-gl
66

77
If you depend on mapbox-gl directly, simply replace `mapbox-gl` with `maplibre-gl` in `package.json`:
8+
9+
Use
10+
811
```diff
912
"dependencies": {
1013
- "mapbox-gl": "^1.13.0"
11-
+ "maplibre-gl": ">=1.14.0"
14+
+ "maplibre-gl": ">=1.15.2"
1215
}
1316
```
1417

15-
And replace ```mapboxgl``` with ```maplibregl``` in your JavaScript and optionally in your HTML/CSS code:
18+
if it is important to you that the behaviour is similar to `mapbox-gl` version 1.x.
19+
20+
And replace `mapboxgl` with `maplibregl` in your JavaScript and optionally in your HTML/CSS code:
21+
22+
> MapLibre GL JS is distributed via [unpkg.com](https://unpkg.com). For more informations please see [MapLibre GL is on unpkg.com](./docs/README-unpkg.md#maplibre-gl-on-unpkgcom).
23+
1624
```diff
25+
- <script src="https://api.mapbox.com/mapbox-gl-js/v1.13.0/mapbox-gl.js"></script>
26+
- <link
27+
- href="https://api.mapbox.com/mapbox-gl-js/v1.13.0/mapbox-gl.css"
28+
- rel="stylesheet"
29+
- />
30+
31+
<!-- Use maplibre-gl version 1.15.2 for backwards compatibility with mapbox-gl version 1.x. -->
32+
+ <script src="https://unpkg.com/maplibre-gl@1.15.2/dist/maplibre-gl.js"></script>
33+
+ <link
34+
+ href="https://unpkg.com/maplibre-gl@1.15.2/dist/maplibre-gl.css"
35+
+ rel="stylesheet"
36+
+ />
37+
1738
- var map = new mapboxgl.Map({
1839
+ var map = new maplibregl.Map({
1940

2041
- <button class="mapboxgl-ctrl">
2142
+ <button class="maplibregl-ctrl">
2243
```
2344

24-
Want an example? Have a look at the official [MapLibre GL JS Documentation](https://maplibre.org/maplibre-gl-js-docs/example/).
45+
Want an example? Have a look at the official [MapLibre GL JS Documentation](https://maplibre.org/maplibre-gl-js-docs/example/).
2546

2647
Use MapLibre GL JS bindings for React (https://visgl.github.io/react-map-gl/docs/get-started/get-started#using-with-a-mapbox-gl-fork) and Angular (https://github.com/maplibre/ngx-maplibre-gl). Find more at [awesome-maplibre](https://github.com/maplibre/awesome-maplibre).
2748

2849
### Roadmap
2950

30-
This project's initial plans are outlined in the [Roadmap](https://github.com/maplibre/maplibre-gl-js/projects/2) project. The primary goal is consistency and backward compatibility with previous releases and continued bug fixes and maintenance as we advance.
51+
This project's initial plans are outlined in the [Roadmap](https://github.com/maplibre/maplibre-gl-js/projects/2) project. The primary goal is consistency and continued bug fixes and maintenance as we advance.
52+
53+
> **MapLibre GL** is developed following [Semantic Versioning (2.0.0)](http://semver.org/spec/v2.0.0.html).
3154
3255
### Getting Involved
3356

@@ -49,4 +72,4 @@ Please keep in mind: Unauthorized backports are the biggest threat to the MapLib
4972

5073
## License
5174

52-
MapLibre GL is licensed under the [3-Clause BSD license](./LICENSE.txt).
75+
**MapLibre GL** is licensed under the [3-Clause BSD license](./LICENSE.txt).

0 commit comments

Comments
 (0)