Move app-facing code to separate folder

README.md

@@ -1,56 +1,11 @@
-# Flutter Google Api Availability Plugin  
+# Flutter Google API Availability plugin
 
-[![pub package](https://img.shields.io/pub/v/google_api_availability.svg)](https://pub.dartlang.org/packages/google_api_availability) ![Build status](https://github.com/Baseflow/flutter-google-api-availability/workflows/google_api_availability/badge.svg?branch=master) [![codecov](https://codecov.io/gh/Baseflow/flutter-google-api-availability/branch/master/graph/badge.svg)](https://codecov.io/gh/Baseflow/flutter-google-api-availability)
+The Flutter Google API Availability plugin is built following the federated plugin architecture. A detailed explanation of the federated plugin concept can be found in the [Flutter documentation](https://flutter.dev/docs/development/packages-and-plugins/developing-packages#federated-plugins). This means the Google API Availability plugin is separated into the following packages:
 
-A Flutter plugin to check the availability of Google Play services on the current device. 
+1. [`google_api_availability`][1]: the app facing package. This is the package users depend on to use the plugin in their project. For details on how to use the [`google_api_availability`][1] plugin you can refer to its [README.md][2] file.
+2. [`google_api_availability_platform_interface`][3]: this package declares the interface which all platform packages must implement to support the app-facing package. Instructions on how to implement a platform package can be found in the [README.md][4] of the [`google_api_availability_platform_interface`][3] package.
 
-## Features
-
-* Check the availability of Google Play services (on Android only).
-
-## Usage
-
-To use this plugin, add `google_api_availability` as a [dependency in your pubspec.yaml file](https://flutter.io/platform-plugins/). For example:
-
-```yaml
-dependencies:
-  google_api_availability: ^3.0.2
-```
-
-> **NOTE:** There's a known issue with integrating plugins that use Swift into a Flutter project created with the Objective-C template. See issue [Flutter#16049](https://github.com/flutter/flutter/issues/16049) for help on integration.
-
-## API
-
-### GoogleApiAvailability
-
-To check the availability of Google Play services on the current device, you can use the `checkGooglePlayServicesAvailability` method. This could be helpful to provide a more friendly experience to users in case an user-action is required to enable support for Google Play services (More information can be found [here](https://developers.google.com/android/guides/setup)). 
-
-``` dart
-import `package:google_api_availability/google_api_availability.dart`;
-
-GooglePlayServicesAvailability availability = await GoogleApiAvailability.instance.checkGooglePlayServicesAvailability();
-```
-
-If you want to show a dialog by the Android system with more information and show a possible fix to the user you can do:
-
-``` dart
-import `package:google_api_availability/google_api_availability.dart`;
-
-GooglePlayServicesAvailability availability = await GoogleApiAvailability.instance.checkGooglePlayServicesAvailability(true);
-```
-
-**Note that on iOS this will always return `notAvailableOnPlatform`!**
-
-See also the [example](example/lib/main.dart) project for a complete implementation.
-
-## Issues
-
-Please file any issues, bugs or feature request as an issue on our [GitHub](https://github.com/BaseflowIT/flutter-google-api-availability/issues) page.
-
-## Want to contribute
-
-If you would like to contribute to the plugin (e.g. by improving the documentation, solving a bug or adding a cool new feature), please carefully review our [contribution guide](CONTRIBUTING.md) and send us your [pull request](https://github.com/BaseflowIT/flutter-google-api-availability/pulls).
-
-## Author
-
-This Google Api Availability plugin for Flutter is developed by [Baseflow](https://baseflow.com). You can contact us at <[email protected]>
+[1]: ./google_api_availability
+[2]: ./google_api_availability/README.md
+[3]: ./google_api_availability_platform_interface
+[4]: ./google_api_availability_platform_interface/README.md

google_api_availability/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Baseflow
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

google_api_availability/README.md

@@ -0,0 +1,56 @@
+# Flutter Google Api Availability Plugin  
+
+[![pub package](https://img.shields.io/pub/v/google_api_availability.svg)](https://pub.dartlang.org/packages/google_api_availability) ![Build status](https://github.com/Baseflow/flutter-google-api-availability/workflows/google_api_availability/badge.svg?branch=master) [![codecov](https://codecov.io/gh/Baseflow/flutter-google-api-availability/branch/master/graph/badge.svg)](https://codecov.io/gh/Baseflow/flutter-google-api-availability)
+
+A Flutter plugin to check the availability of Google Play services on the current device. 
+
+## Features
+
+* Check the availability of Google Play services (on Android only).
+
+## Usage
+
+To use this plugin, add `google_api_availability` as a [dependency in your pubspec.yaml file](https://flutter.io/platform-plugins/). For example:
+
+```yaml
+dependencies:
+  google_api_availability: ^3.0.2
+```
+
+> **NOTE:** There's a known issue with integrating plugins that use Swift into a Flutter project created with the Objective-C template. See issue [Flutter#16049](https://github.com/flutter/flutter/issues/16049) for help on integration.
+
+## API
+
+### GoogleApiAvailability
+
+To check the availability of Google Play services on the current device, you can use the `checkGooglePlayServicesAvailability` method. This could be helpful to provide a more friendly experience to users in case an user-action is required to enable support for Google Play services (More information can be found [here](https://developers.google.com/android/guides/setup)). 
+
+``` dart
+import `package:google_api_availability/google_api_availability.dart`;
+
+GooglePlayServicesAvailability availability = await GoogleApiAvailability.instance.checkGooglePlayServicesAvailability();
+```
+
+If you want to show a dialog by the Android system with more information and show a possible fix to the user you can do:
+
+``` dart
+import `package:google_api_availability/google_api_availability.dart`;
+
+GooglePlayServicesAvailability availability = await GoogleApiAvailability.instance.checkGooglePlayServicesAvailability(true);
+```
+
+**Note that on iOS this will always return `notAvailableOnPlatform`!**
+
+See also the [example](example/lib/main.dart) project for a complete implementation.
+
+## Issues
+
+Please file any issues, bugs or feature request as an issue on our [GitHub](https://github.com/BaseflowIT/flutter-google-api-availability/issues) page.
+
+## Want to contribute
+
+If you would like to contribute to the plugin (e.g. by improving the documentation, solving a bug or adding a cool new feature), please carefully review our [contribution guide](CONTRIBUTING.md) and send us your [pull request](https://github.com/BaseflowIT/flutter-google-api-availability/pulls).
+
+## Author
+
+This Google API Availability plugin for Flutter is developed by [Baseflow](https://baseflow.com). You can contact us at <[email protected]>

lib/src/google_api_availability.dart → google_api_availability/lib/src/google_api_availability.dart

@@ -1,7 +1,8 @@
 import 'dart:async';
 import 'package:flutter/foundation.dart';
 import 'package:flutter/services.dart';
-import 'package:google_api_availability/src/models/google_play_services_availability.dart';
+
+import '../google_api_availability.dart';
 
 /// Flutter plugin to verify if Google Play Services are installed on the
 /// device.