You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+28-5Lines changed: 28 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,29 +5,52 @@
5
5
### Migrating from mapbox-gl
6
6
7
7
If you depend on mapbox-gl directly, simply replace `mapbox-gl` with `maplibre-gl` in `package.json`:
8
+
9
+
Use
10
+
8
11
```diff
9
12
"dependencies": {
10
13
- "mapbox-gl": "^1.13.0"
11
-
+ "maplibre-gl": ">=1.14.0"
14
+
+ "maplibre-gl": ">=1.15.2"
12
15
}
13
16
```
14
17
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).
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/).
25
46
26
47
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).
27
48
28
49
### Roadmap
29
50
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).
31
54
32
55
### Getting Involved
33
56
@@ -49,4 +72,4 @@ Please keep in mind: Unauthorized backports are the biggest threat to the MapLib
49
72
50
73
## License
51
74
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