docs: Update changelog, license and readme

renefloor · renefloor · commit 916fe99b0f19 · 2024-05-06T14:55:41.000+02:00
Signed-off-by: Rene Floor &lt;rene.floor@ah.nl&gt;
diff --git a/README.md b/README.md
@@ -23,7 +23,7 @@ This package combines the `google_maps_flutter` plugin with `apple_maps_flutter`
 
 # iOS
 
-To use this plugin on iOS you need to opt-in for the embedded views preview by adding a boolean property to the app's Info.plist file, with the key `io.flutter.embedded_views_preview` and the value `YES`. You will also have to add the key `Privacy - Location When In Use Usage Description` with the value of your usage description.
+You will have to add the key `Privacy - Location When In Use Usage Description` with the value of your usage description.
 
 # Android
 
diff --git a/packages/platform_maps_flutter/CHANGELOG.md b/packages/platform_maps_flutter/CHANGELOG.md
@@ -1,3 +1,7 @@
+## 2.0.0-beta
+
+* Migrate to a federated plugin structure
+
 ## 1.0.2
 
 * Updates apple_maps_flutter to apply memory leak fix
diff --git a/packages/platform_maps_flutter_apple/CHANGELOG.md b/packages/platform_maps_flutter_apple/CHANGELOG.md
@@ -1,3 +1,3 @@
-## 0.0.1
+## 1.0.0-beta
 
-* TODO: Describe initial release.
+* Initial version, based on platform_maps_flutter 1.0.2
diff --git a/packages/platform_maps_flutter_apple/LICENSE b/packages/platform_maps_flutter_apple/LICENSE
@@ -1 +1,25 @@
-TODO: Add your license here.
+BSD 2-Clause License
+
+Copyright (c) 2019, Luis Thein
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
diff --git a/packages/platform_maps_flutter_apple/README.md b/packages/platform_maps_flutter_apple/README.md
@@ -1,39 +1,4 @@
-<!--
-This README describes the package. If you publish this package to pub.dev,
-this README's contents appear on the landing page for your package.
+# platform_maps_flutter_apple
 
-For information about how to write a good package README, see the guide for
-[writing package pages](https://dart.dev/guides/libraries/writing-package-pages).
-
-For general information about developing packages, see the Dart guide for
-[creating packages](https://dart.dev/guides/libraries/create-library-packages)
-and the Flutter guide for
-[developing packages and plugins](https://flutter.dev/developing-packages).
--->
-
-TODO: Put a short description of the package here that helps potential users
-know whether this package might be useful for them.
-
-## Features
-
-TODO: List what your package can do. Maybe include images, gifs, or videos.
-
-## Getting started
-
-TODO: List prerequisites and provide or point to information on how to
-start using the package.
-
-## Usage
-
-TODO: Include short and useful examples for package users. Add longer examples
-to `/example` folder.
-
-```dart
-const like = 'sample';
-```
-
-## Additional information
-
-TODO: Tell users more about the package: where to find more information, how to
-contribute to the package, how to file issues, what response they can expect
-from the package authors, and more.
+This is the Apple (iOS) implementation of the `platform_maps_flutter` plugin.
+If you add `platform_maps_flutter` to your pubspec.yaml this will automatically be used.
diff --git a/packages/platform_maps_flutter_google_android/CHANGELOG.md b/packages/platform_maps_flutter_google_android/CHANGELOG.md
@@ -1,3 +1,3 @@
-## 0.0.1
+## 1.0.0-beta
 
-* TODO: Describe initial release.
+* Initial version, based on platform_maps_flutter 1.0.2
diff --git a/packages/platform_maps_flutter_google_android/LICENSE b/packages/platform_maps_flutter_google_android/LICENSE
@@ -1 +1,25 @@
-TODO: Add your license here.
+BSD 2-Clause License
+
+Copyright (c) 2019, Luis Thein
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
diff --git a/packages/platform_maps_flutter_google_android/README.md b/packages/platform_maps_flutter_google_android/README.md
@@ -1,39 +1,6 @@
-<!--
-This README describes the package. If you publish this package to pub.dev,
-this README's contents appear on the landing page for your package.
+# platform_maps_flutter_google_android
 
-For information about how to write a good package README, see the guide for
-[writing package pages](https://dart.dev/guides/libraries/writing-package-pages).
+This is the Google Maps for Android implementation of the `platform_maps_flutter` plugin.
+If you add `platform_maps_flutter` to your pubspec.yaml this will automatically be used.
 
-For general information about developing packages, see the Dart guide for
-[creating packages](https://dart.dev/guides/libraries/create-library-packages)
-and the Flutter guide for
-[developing packages and plugins](https://flutter.dev/developing-packages).
--->
-
-TODO: Put a short description of the package here that helps potential users
-know whether this package might be useful for them.
-
-## Features
-
-TODO: List what your package can do. Maybe include images, gifs, or videos.
-
-## Getting started
-
-TODO: List prerequisites and provide or point to information on how to
-start using the package.
-
-## Usage
-
-TODO: Include short and useful examples for package users. Add longer examples
-to `/example` folder.
-
-```dart
-const like = 'sample';
-```
-
-## Additional information
-
-TODO: Tell users more about the package: where to find more information, how to
-contribute to the package, how to file issues, what response they can expect
-from the package authors, and more.
+It's Android only to prevent iOS dependencies for Google Maps being added to your project.
diff --git a/packages/platform_maps_flutter_platform_interface/CHANGELOG.md b/packages/platform_maps_flutter_platform_interface/CHANGELOG.md
@@ -1,3 +1,3 @@
-## 1.0.0
+## 1.0.0-beta
 
-- Initial platform_interface
+* Initial version, based on platform_maps_flutter 1.0.2
diff --git a/packages/platform_maps_flutter_platform_interface/LICENSE b/packages/platform_maps_flutter_platform_interface/LICENSE
@@ -0,0 +1,25 @@
+BSD 2-Clause License
+
+Copyright (c) 2019, Luis Thein
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
diff --git a/packages/platform_maps_flutter_platform_interface/README.md b/packages/platform_maps_flutter_platform_interface/README.md
@@ -1,39 +1,23 @@
-<!-- 
-This README describes the package. If you publish this package to pub.dev,
-this README's contents appear on the landing page for your package.
+# platform_maps_flutter_platform_interface
 
-For information about how to write a good package README, see the guide for
-[writing package pages](https://dart.dev/guides/libraries/writing-package-pages). 
+A common platform interface for the `platform_maps_flutter` plugin.
 
-For general information about developing packages, see the Dart guide for
-[creating packages](https://dart.dev/guides/libraries/create-library-packages)
-and the Flutter guide for
-[developing packages and plugins](https://flutter.dev/developing-packages). 
--->
+This interface allows platform-specific implementations of the `platform_maps_flutter`
+plugin, as well as the plugin itself, to ensure they are supporting the
+same interface.
 
-TODO: Put a short description of the package here that helps potential users
-know whether this package might be useful for them.
+# Usage
 
-## Features
+To implement a new platform-specific implementation of `platform_maps_flutter`, extend
+`PlatformMapsPlatform` with an implementation that performs the
+platform-specific behavior, and when you register your plugin, set the default
+`PlatformMapsPlatform` by calling
+`PlatformMapsPlatform.instance = MyCustomPlatformMapsPlatform()`.
 
-TODO: List what your package can do. Maybe include images, gifs, or videos.
+# Note on breaking changes
 
-## Getting started
+Strongly prefer non-breaking changes (such as adding a method to the interface)
+over breaking changes for this package.
 
-TODO: List prerequisites and provide or point to information on how to
-start using the package.
-
-## Usage
-
-TODO: Include short and useful examples for package users. Add longer examples
-to `/example` folder. 
-
-```dart
-const like = 'sample';
-```
-
-## Additional information
-
-TODO: Tell users more about the package: where to find more information, how to 
-contribute to the package, how to file issues, what response they can expect 
-from the package authors, and more.
+See https://flutter.dev/go/platform-interface-breaking-changes for a discussion
+on why a less-clean interface is preferable to a breaking change.
