docs: update changelog and migration guide (#94)

Author: josxha

CHANGELOG.md

@@ -12,6 +12,7 @@
   to [3.24.0](https://medium.com/flutter/whats-new-in-flutter-3-24-6c040f87d1e4)
   (Minimum Dart version
   of [3.5.0](https://medium.com/dartlang/dart-3-5-6ca36259fa2f)).
+- Can't await the end of `animateCamera()` in this version.
 
 Read the [Upgrade Guide](https://flutter-maplibre.pages.dev/docs/upgrade) for
 instructions on how to upgrade.

docs/docs/upgrade.md

@@ -11,10 +11,9 @@ through all of them.
 ## General Information on Breaking Changes
 
 We are using
-the [pub.dev version convention](https://dart.dev/tools/pub/versioning) for the
-package.
-
-While the package is prior its `1.0.0` release, the following rules apply:
+the [pub.dev version convention](https://dart.dev/tools/pub/versioning#semantic-versions)
+for the package. While the package is prior its `1.0.0` release, the following
+rules apply:
 
 - Every minor `0.x.0` release can introduce breaking changes.
 - Every increase of the patch value `0.0.x` adds new features and functionality.
@@ -24,9 +23,6 @@ While the package is prior its `1.0.0` release, the following rules apply:
 By setting `^0.1.0` in your pubspec.yaml file pub will automatically resolve a
 compatible package version but won't use the next breaking release `0.2.0`.
 
-Read [Semantic versions](https://dart.dev/tools/pub/versioning#semantic-versions)
-for more information.
-
 ## Step-by-Step guide
 
 ### 1. Compatible Flutter Version
@@ -41,22 +37,22 @@ Run `flutter upgrade` to upgrade Flutter.
 Some properties and class names have changed. Replace the old with the new
 names.
 
-| Old Name               | New Name                    |
-|------------------------|-----------------------------|
-| controller.jumpTo()    | controller.moveCamera()     |
-| controller.flyTo()     | controller.animateCamera()  |
-| MapOptions(controls: ) | MapOptions(webControls: )   |
-| MapOptions(style: )    | MapOptions(initStyle: )     |
-| MapOptions(zoom: )     | MapOptions(initZoom: )      |
-| MapOptions(center: )   | MapOptions(initCenter: )    |
-| MapOptions(bearing: )  | MapOptions(initBearing: )   |
-| MapControl()           | WebMapControl()             |
-| ScaleControl()         | WebScaleControl()           |
-| LogoControl()          | WebLogoControl()            |
-| GeolocateControl()     | WebGeolocateControl()       |
-| FullscreenControl()    | WebFullscreenControl()      |
-| NavigationControl()    | WebNavigationControl()      |
-| mapCamera.tilt         | mapCamera.pitch             |
+| Old Name               | New Name                   |
+|------------------------|----------------------------|
+| controller.jumpTo()    | controller.moveCamera()    |
+| controller.flyTo()     | controller.animateCamera() |
+| MapOptions(controls: ) | MapOptions(webControls: )  |
+| MapOptions(style: )    | MapOptions(initStyle: )    |
+| MapOptions(zoom: )     | MapOptions(initZoom: )     |
+| MapOptions(center: )   | MapOptions(initCenter: )   |
+| MapOptions(bearing: )  | MapOptions(initBearing: )  |
+| MapControl()           | WebMapControl()            |
+| ScaleControl()         | WebScaleControl()          |
+| LogoControl()          | WebLogoControl()           |
+| GeolocateControl()     | WebGeolocateControl()      |
+| FullscreenControl()    | WebFullscreenControl()     |
+| NavigationControl()    | WebNavigationControl()     |
+| mapCamera.tilt         | mapCamera.pitch            |
 
 ### 3. Use the event system
 
@@ -68,4 +64,11 @@ Check out the [Map Events](./events) documentation to see how you can use them.
 | onClick           | MapEventClick          |
 | onDoubleClick     | MapEventDoubleClick    |
 | onSecondaryClick  | MapEventSecondaryClick |
-| onLongClick       | MapEventLongClick      |
+| onLongClick       | MapEventLongClick      |
+
+### 4. Removed functionality
+
+It is currently not possible to await the end of `controller.animateCamera()`
+because of deadlock issues with callbacks in jni.
+In the meantime, you have to rely on `MapEventCameraIdle` to detect once
+animation is finished.

docs/versioned_docs/version-0.1.0/upgrade.md

@@ -11,10 +11,9 @@ through all of them.
 ## General Information on Breaking Changes
 
 We are using
-the [pub.dev version convention](https://dart.dev/tools/pub/versioning) for the
-package.
-
-While the package is prior its `1.0.0` release, the following rules apply:
+the [pub.dev version convention](https://dart.dev/tools/pub/versioning#semantic-versions)
+for the package. While the package is prior its `1.0.0` release, the following
+rules apply:
 
 - Every minor `0.x.0` release can introduce breaking changes.
 - Every increase of the patch value `0.0.x` adds new features and functionality.
@@ -24,9 +23,6 @@ While the package is prior its `1.0.0` release, the following rules apply:
 By setting `^0.1.0` in your pubspec.yaml file pub will automatically resolve a
 compatible package version but won't use the next breaking release `0.2.0`.
 
-Read [Semantic versions](https://dart.dev/tools/pub/versioning#semantic-versions)
-for more information.
-
 ## Step-by-Step guide
 
 ### 1. Compatible Flutter Version
@@ -41,22 +37,22 @@ Run `flutter upgrade` to upgrade Flutter.
 Some properties and class names have changed. Replace the old with the new
 names.
 
-| Old Name               | New Name                    |
-|------------------------|-----------------------------|
-| controller.jumpTo()    | controller.moveCamera()     |
-| controller.flyTo()     | controller.animateCamera()  |
-| MapOptions(controls: ) | MapOptions(webControls: )   |
-| MapOptions(style: )    | MapOptions(initStyle: )     |
-| MapOptions(zoom: )     | MapOptions(initZoom: )      |
-| MapOptions(center: )   | MapOptions(initCenter: )    |
-| MapOptions(bearing: )  | MapOptions(initBearing: )   |
-| MapControl()           | WebMapControl()             |
-| ScaleControl()         | WebScaleControl()           |
-| LogoControl()          | WebLogoControl()            |
-| GeolocateControl()     | WebGeolocateControl()       |
-| FullscreenControl()    | WebFullscreenControl()      |
-| NavigationControl()    | WebNavigationControl()      |
-| mapCamera.tilt         | mapCamera.pitch             |
+| Old Name               | New Name                   |
+|------------------------|----------------------------|
+| controller.jumpTo()    | controller.moveCamera()    |
+| controller.flyTo()     | controller.animateCamera() |
+| MapOptions(controls: ) | MapOptions(webControls: )  |
+| MapOptions(style: )    | MapOptions(initStyle: )    |
+| MapOptions(zoom: )     | MapOptions(initZoom: )     |
+| MapOptions(center: )   | MapOptions(initCenter: )   |
+| MapOptions(bearing: )  | MapOptions(initBearing: )  |
+| MapControl()           | WebMapControl()            |
+| ScaleControl()         | WebScaleControl()          |
+| LogoControl()          | WebLogoControl()           |
+| GeolocateControl()     | WebGeolocateControl()      |
+| FullscreenControl()    | WebFullscreenControl()     |
+| NavigationControl()    | WebNavigationControl()     |
+| mapCamera.tilt         | mapCamera.pitch            |
 
 ### 3. Use the event system
 
@@ -68,4 +64,11 @@ Check out the [Map Events](./events) documentation to see how you can use them.
 | onClick           | MapEventClick          |
 | onDoubleClick     | MapEventDoubleClick    |
 | onSecondaryClick  | MapEventSecondaryClick |
-| onLongClick       | MapEventLongClick      |
+| onLongClick       | MapEventLongClick      |
+
+### 4. Removed functionality
+
+It is currently not possible to await the end of `controller.animateCamera()`
+because of deadlock issues with callbacks in jni.
+In the meantime, you have to rely on `MapEventCameraIdle` to detect once
+animation is finished.

example/web/favicon-32x32.png

@@ -27,7 +27,7 @@
   <link rel="apple-touch-icon" href="icons/Icon-192.png">
 
   <!-- Favicon -->
-  <link rel="icon" type="image/png" href="favicon.png"/>
+  <link rel="icon" type="image/png" href="favicon-32x32.png"/>
 
   <!-- MapLibre -->
   <script src='https://unpkg.com/maplibre-gl@^4.3/dist/maplibre-gl.js'></script>