diff --git a/packages/battery_plus_platform_interface/README.md b/packages/battery_plus_platform_interface/README.md index f75eaa0b88..b1abad1b0c 100644 --- a/packages/battery_plus_platform_interface/README.md +++ b/packages/battery_plus_platform_interface/README.md @@ -1,26 +1,12 @@ -# battery_plus_platform_interface +# Battery Plus Platform Interface -A common platform interface for the [`battery_plus`][1] plugin. +[![Flutter Community: battery_plus_platform_interface](https://fluttercommunity.dev/_github/header/battery_plus_platform_interface)](https://github.com/fluttercommunity/community) -This interface allows platform-specific implementations of the `battery_plus` -plugin, as well as the plugin itself, to ensure they are supporting the -same interface. +[![pub package](https://img.shields.io/pub/v/battery_plus_platform_interface.svg)](https://pub.dev/packages/battery_plus_platform_interface) -# Usage +A common platform interface for [`battery_plus`](https://pub.dev/packages/battery_plus). -To implement a new platform-specific implementation of `battery_plus`, extend -[`BatteryPlatform`][2] with an implementation that performs the -platform-specific behavior, and when you register your plugin, set the default -`BatteryPlatform` by calling -`BatteryPlatform.instance = MyPlatformBattery()`. +## Usage -# Note on breaking changes - -Strongly prefer non-breaking changes (such as adding a method to the interface) -over breaking changes for this package. - -See https://flutter.dev/go/platform-interface-breaking-changes for a discussion -on why a less-clean interface is preferable to a breaking change. - -[1]: ../ -[2]: lib/batteru_plus_platform_interface.dart +This package is already included as part of the `battery_plus` package dependency, and will +be included when using `battery_plus` as normal. diff --git a/packages/battery_plus_web/README.md b/packages/battery_plus_web/README.md index 15d725e354..77d12d0602 100644 --- a/packages/battery_plus_web/README.md +++ b/packages/battery_plus_web/README.md @@ -1,5 +1,12 @@ -# battery_plus_web +# Battery Plus Web -Web implementation of [`battery_plus`][1] +[![Flutter Community: battery_plus_web](https://fluttercommunity.dev/_github/header/battery_plus_web)](https://github.com/fluttercommunity/community) -[1]: ../ \ No newline at end of file +[![pub package](https://img.shields.io/pub/v/battery_plus_web.svg)](https://pub.dev/packages/battery_plus_web) + +The Web implementation of [`battery_plus`](https://pub.dev/packages/battery_plus). + +## Usage + +This package is already included as part of the `battery_plus` package dependency, and will +be included when using `battery_plus` as normal. diff --git a/packages/connectivity_plus/README.md b/packages/connectivity_plus/README.md index 01d680abfa..09176cf180 100644 --- a/packages/connectivity_plus/README.md +++ b/packages/connectivity_plus/README.md @@ -11,13 +11,6 @@ This plugin works for iOS and Android. > Note that on Android, this does not guarantee connection to Internet. For instance, the app might have wifi access but it might be a VPN or a hotel WiFi with no access. -**Please set your constraint to `connectivity: '>=0.4.y+x <2.0.0'`** - -## Backward compatible 1.0.0 version is coming -The plugin has reached a stable API, we guarantee that version `1.0.0` will be backward compatible with `0.4.y+z`. -Please use `connectivity: '>=0.4.y+x <2.0.0'` as your dependency constraint to allow a smoother ecosystem migration. -For more details see: https://github.com/flutter/flutter/wiki/Package-migration-to-1.0.0 - ## Usage Sample usage to check current status: @@ -107,6 +100,25 @@ To request location authorization, make sure to add the following keys to your _ * `NSLocationAlwaysAndWhenInUseUsageDescription` - describe why the app needs access to the user’s location information all the time (foreground and background). This is called _Privacy - Location Always and When In Use Usage Description_ in the visual editor. * `NSLocationWhenInUseUsageDescription` - describe why the app needs access to the user’s location information when the app is running in the foreground. This is called _Privacy - Location When In Use Usage Description_ in the visual editor. +## Limitations on the web platform + +In order to retrieve information about the quality/speed of a browser's connection, the web implementation of the `connectivity` plugin uses the browser's [**NetworkInformation** Web API](https://developer.mozilla.org/en-US/docs/Web/API/NetworkInformation), which as of this writing (June 2020) is still "experimental", and not available in all browsers: + +![Data on support for the netinfo feature across the major browsers from caniuse.com](https://caniuse.bitsofco.de/image/netinfo.png) + +On desktop browsers, this API only returns a very broad set of connectivity statuses (One of `'slow-2g', '2g', '3g', or '4g'`), and may *not* provide a Stream of changes. Firefox still hasn't enabled this feature by default. + +**Fallback to `navigator.onLine`** + +For those browsers where the NetworkInformation Web API is not available, the plugin falls back to the [**NavigatorOnLine** Web API](https://developer.mozilla.org/en-US/docs/Web/API/NavigatorOnLine), which is more broadly supported: + +![Data on support for the online-status feature across the major browsers from caniuse.com](https://caniuse.bitsofco.de/image/online-status.png) + + +The NavigatorOnLine API is [provided by `dart:html`](https://api.dart.dev/stable/2.7.2/dart-html/Navigator/onLine.html), and only supports a boolean connectivity status (either online or offline), with no network speed information. In those cases the plugin will return either `wifi` (when the browser is online) or `none` (when it's not). + +Other than the approximate "downlink" speed, where available, and due to security and privacy concerns, **no Web browser will provide** any specific information about the actual network your users' device is connected to, like **the SSID on a Wi-Fi, or the MAC address of their device.** + ## Getting Started For help getting started with Flutter, view our online diff --git a/packages/connectivity_plus_macos/README.md b/packages/connectivity_plus_macos/README.md index 3e02a1dd38..23f92ca6a0 100644 --- a/packages/connectivity_plus_macos/README.md +++ b/packages/connectivity_plus_macos/README.md @@ -1,37 +1,12 @@ -# connectivity_plus_macos +# Connectivity Plus macOS [![Flutter Community: connectivity_plus_macos](https://fluttercommunity.dev/_github/header/connectivity_plus_macos)](https://github.com/fluttercommunity/community) [![pub package](https://img.shields.io/pub/v/connectivity_plus_macos.svg)](https://pub.dev/packages/connectivity_plus_macos) - -The macos implementation of [`connectivity_plus`]. - -**Please set your constraint to `connectivity_macos: '>=0.1.y+x <2.0.0'`** - -## Backward compatible 1.0.0 version is coming -The plugin has reached a stable API, we guarantee that version `1.0.0` will be backward compatible with `0.1.y+z`. -Please use `connectivity_macos: '>=0.1.y+x <2.0.0'` as your dependency constraint to allow a smoother ecosystem migration. -For more details see: https://github.com/flutter/flutter/wiki/Package-migration-to-1.0.0 +The macOS implementation of [`connectivity_plus`](https://pub.dev/packages/connectivity_plus). ## Usage -### Import the package - - -This package has been endorsed, meaning that you only need to add `connectivity_plus` -as a dependency in your `pubspec.yaml`. It will be automatically included in your app -when you depend on `package:connectivity_plus`. - -This is what the above means to your `pubspec.yaml`: - -```yaml -... -dependencies: - ... - connectivity_plus: ^0.4.9 - ... -``` - -Refer to the `connectivity_plus` [documentation](https://github.com/fluttercommunity/connectivity_plus) for more details. - +This package is already included as part of the `connectivity_plus` package dependency, and will +be included when using `connectivity_plus` as normal. diff --git a/packages/connectivity_plus_platform_interface/README.md b/packages/connectivity_plus_platform_interface/README.md index ad3ad5e115..dfdb11d105 100644 --- a/packages/connectivity_plus_platform_interface/README.md +++ b/packages/connectivity_plus_platform_interface/README.md @@ -1,30 +1,12 @@ -# connectivity_plus_platform_interface +# Connectivity Plus Platform Interface [![Flutter Community: connectivity_plus_platform_interface](https://fluttercommunity.dev/_github/header/connectivity_plus_platform_interface)](https://github.com/fluttercommunity/community) [![pub package](https://img.shields.io/pub/v/connectivity_plus_platform_interface.svg)](https://pub.dev/packages/connectivity_plus_platform_interface) -A common platform interface for the [`connectivity_plus`][1] plugin. +A common platform interface for [`connectivity_plus`](https://pub.dev/packages/connectivity_plus). -This interface allows platform-specific implementations of the `connectivity_plus` -plugin, as well as the plugin itself, to ensure they are supporting the -same interface. +## Usage -# Usage - -To implement a new platform-specific implementation of `connectivity_plus`, extend -[`ConnectivityPlatform`][2] with an implementation that performs the -platform-specific behavior, and when you register your plugin, set the default -`ConnectivityPlatform` by calling -`ConnectivityPlatform.instance = MyPlatformConnectivity()`. - -# Note on breaking changes - -Strongly prefer non-breaking changes (such as adding a method to the interface) -over breaking changes for this package. - -See https://flutter.dev/go/platform-interface-breaking-changes for a discussion -on why a less-clean interface is preferable to a breaking change. - -[1]: ../ -[2]: lib/connectivity_plus_platform_interface.dart +This package is already included as part of the `connectivity_plus` package dependency, and will +be included when using `connectivity_plus` as normal. diff --git a/packages/connectivity_plus_web/README.md b/packages/connectivity_plus_web/README.md index de8706041a..b42eb86081 100644 --- a/packages/connectivity_plus_web/README.md +++ b/packages/connectivity_plus_web/README.md @@ -1,66 +1,12 @@ -# connectivity_plus_web +# Connectivity Plus Web [![Flutter Community: connectivity_plus_web](https://fluttercommunity.dev/_github/header/connectivity_plus_web)](https://github.com/fluttercommunity/community) [![pub package](https://img.shields.io/pub/v/connectivity_plus_web.svg)](https://pub.dev/packages/connectivity_plus_web) -A web implementation of [connectivity](https://pub.dev/connectivity_plus/connectivity_plus). Currently this package uses an experimental API, with a fallback to dart:html, so not all features may be available to all browsers. +The Web implementation of [`connectivity_plus`](https://pub.dev/packages/connectivity_plus). ## Usage -### Import the package - -This package is a non-endorsed implementation of `connectivity_plus` for the web platform, so you need to modify your `pubspec.yaml` to use it: - -```yaml -... -dependencies: - ... - connectivity_plus: ^0.4.9 - connectivity_plus_web: ^0.3.0 - ... -... -``` - -## Example - -Find the example wiring in the [Google sign-in example application](https://github.com/fluttercommunity/connectivity_plus/connectivity_plus/example/lib/main.dart). - -## Limitations on the web platform - -In order to retrieve information about the quality/speed of a browser's connection, the web implementation of the `connectivity` plugin uses the browser's [**NetworkInformation** Web API](https://developer.mozilla.org/en-US/docs/Web/API/NetworkInformation), which as of this writing (June 2020) is still "experimental", and not available in all browsers: - -![Data on support for the netinfo feature across the major browsers from caniuse.com](https://caniuse.bitsofco.de/image/netinfo.png) - -On desktop browsers, this API only returns a very broad set of connectivity statuses (One of `'slow-2g', '2g', '3g', or '4g'`), and may *not* provide a Stream of changes. Firefox still hasn't enabled this feature by default. - -**Fallback to `navigator.onLine`** - -For those browsers where the NetworkInformation Web API is not available, the plugin falls back to the [**NavigatorOnLine** Web API](https://developer.mozilla.org/en-US/docs/Web/API/NavigatorOnLine), which is more broadly supported: - -![Data on support for the online-status feature across the major browsers from caniuse.com](https://caniuse.bitsofco.de/image/online-status.png) - - -The NavigatorOnLine API is [provided by `dart:html`](https://api.dart.dev/stable/2.7.2/dart-html/Navigator/onLine.html), and only supports a boolean connectivity status (either online or offline), with no network speed information. In those cases the plugin will return either `wifi` (when the browser is online) or `none` (when it's not). - -Other than the approximate "downlink" speed, where available, and due to security and privacy concerns, **no Web browser will provide** any specific information about the actual network your users' device is connected to, like **the SSID on a Wi-Fi, or the MAC address of their device.** - -## Contributions and Testing - -Tests are crucial to contributions to this package. All new contributions should be reasonably tested. - -In order to run tests in this package, do: - -``` -cd test -flutter run -d chrome -``` - -All contributions to this package are welcome. Read the [Contributing to Flutter Plugins](https://github.com/flutter/plugins/blob/master/CONTRIBUTING.md) guide to get started. - -## Issues and feedback - -Please file an [issue](https://github.com/fluttercommunity/connectivity_plus/issues/new) -to send feedback or report a bug. - -**Thank you!** +This package is already included as part of the `connectivity_plus` package dependency, and will +be included when using `connectivity_plus` as normal. diff --git a/packages/device_info_plus_platform_interface/README.md b/packages/device_info_plus_platform_interface/README.md index 18bc9d640e..ecbabb01a0 100644 --- a/packages/device_info_plus_platform_interface/README.md +++ b/packages/device_info_plus_platform_interface/README.md @@ -1,31 +1,12 @@ -# device_info_platform_interface - +# Device Info Plus Platform Interface [![Flutter Community: device_info_plus_platform_interface](https://fluttercommunity.dev/_github/header/device_info_plus_platform_interface)](https://github.com/fluttercommunity/community) [![pub package](https://img.shields.io/pub/v/device_info_plus_platform_interface.svg)](https://pub.dev/packages/device_info_plus_platform_interface) -A common platform interface for the [`device_info_plus`][1] plugin. - -This interface allows platform-specific implementations of the `device_info` -plugin, as well as the plugin itself, to ensure they are supporting the -same interface. - -# Usage - -To implement a new platform-specific implementation of `device_info_plus`, extend -[`DeviceInfoPlatform`][2] with an implementation that performs the -platform-specific behavior, and when you register your plugin, set the default -`DeviceInfoPlatform` by calling -`DeviceInfoPlatform.instance = MyPlatformDeviceInfo()`. - -# Note on breaking changes - -Strongly prefer non-breaking changes (such as adding a method to the interface) -over breaking changes for this package. +A common platform interface for [`device_info_plus`](https://pub.dev/packages/device_info_plus). -See https://flutter.dev/go/platform-interface-breaking-changes for a discussion -on why a less-clean interface is preferable to a breaking change. +## Usage -[1]: ../device_info -[2]: lib/device_info_platform_interface.dart +This package is already included as part of the `device_info_plus` package dependency, and will +be included when using `device_info_plus` as normal. diff --git a/packages/device_info_plus_web/README.md b/packages/device_info_plus_web/README.md index 97515540b5..7ac2597708 100644 --- a/packages/device_info_plus_web/README.md +++ b/packages/device_info_plus_web/README.md @@ -1,5 +1,12 @@ -# device_info_plus_web +# Device Info Plus Web -web implementation of [device_info_plus][1] +[![Flutter Community: device_info_plus_web](https://fluttercommunity.dev/_github/header/device_info_plus_web)](https://github.com/fluttercommunity/community) -[1]: ../ \ No newline at end of file +[![pub package](https://img.shields.io/pub/v/device_info_plus_web.svg)](https://pub.dev/packages/device_info_plus_web) + +The Web implementation of [`device_info_plus`](https://pub.dev/packages/device_info_plus). + +## Usage + +This package is already included as part of the `device_info_plus` package dependency, and will +be included when using `device_info_plus` as normal. diff --git a/packages/package_info_plus/README.md b/packages/package_info_plus/README.md index 36ad5d9d32..7d9a6259a4 100644 --- a/packages/package_info_plus/README.md +++ b/packages/package_info_plus/README.md @@ -7,13 +7,6 @@ This Flutter plugin provides an API for querying information about an application package. -**Please set your constraint to `package_info_plus: '>=0.4.y+x <2.0.0'`** - -## Backward compatible 1.0.0 version is coming -The package_info plugin has reached a stable API, we guarantee that version `1.0.0` will be backward compatible with `0.4.y+z`. -Please use `package_info: '>=0.4.y+x <2.0.0'` as your dependency constraint to allow a smoother ecosystem migration. -For more details see: https://github.com/flutter/flutter/wiki/Package-migration-to-1.0.0 - # Usage You can use the PackageInfo to query information about the diff --git a/packages/package_info_plus_macos/README.md b/packages/package_info_plus_macos/README.md index 487bb61487..aa1a12b289 100644 --- a/packages/package_info_plus_macos/README.md +++ b/packages/package_info_plus_macos/README.md @@ -1,34 +1,12 @@ -# package_info_plus_macos +# Package Info Plus macOS -The macos implementation of [`package_info_plus`][1]. +[![Flutter Community: package_info_plus_macos](https://fluttercommunity.dev/_github/header/package_info_plus_macos)](https://github.com/fluttercommunity/community) -## Usage - -### Import the package - -This package has been endorsed, meaning that you only need to add `package_info_plus` -as a dependency in your `pubspec.yaml`. It will be automatically included in your app -when you depend on `package:package_info_plus`. +[![pub package](https://img.shields.io/pub/v/package_info_plus_macos.svg)](https://pub.dev/packages/package_info_plus_macos) -This is what the above means to your `pubspec.yaml`: +The macOS implementation of [`package_info_plus`](https://pub.dev/packages/package_info_plus). -```yaml -... -dependencies: - ... - package_info_plus: ^0.4.5 - ... -``` - -If you wish to use the macos package only, you can add `package_info_plus_macos` as a -dependency: - -```yaml -... -dependencies: - ... - package_info_plus_macos: ^0.0.1 - ... -``` +## Usage -[1]: ../package_info_plus/package_info_plus \ No newline at end of file +This package is already included as part of the `package_info_plus` package dependency, and will +be included when using `package_info_plus` as normal. diff --git a/packages/package_info_plus_platform_interface/README.md b/packages/package_info_plus_platform_interface/README.md index 7c1e171229..66a1af38d9 100644 --- a/packages/package_info_plus_platform_interface/README.md +++ b/packages/package_info_plus_platform_interface/README.md @@ -1,26 +1,12 @@ -# package_info_plus_platform_interface +# Package Info Plus Platform Interface -A common platform interface for the [`package_info_plus`][1] plugin. +[![Flutter Community: package_info_plus_platform_interface](https://fluttercommunity.dev/_github/header/package_info_plus_platform_interface)](https://github.com/fluttercommunity/community) -This interface allows platform-specific implementations of the `package_info_plus` -plugin, as well as the plugin itself, to ensure they are supporting the -same interface. +[![pub package](https://img.shields.io/pub/v/package_info_plus_platform_interface.svg)](https://pub.dev/packages/package_info_plus_platform_interface) -# Usage +A common platform interface for [`package_info_plus`](https://pub.dev/packages/package_info_plus). -To implement a new platform-specific implementation of `package_info_plus`, extend -[`PackageInfoPlatform`][2] with an implementation that performs the -platform-specific behavior, and when you register your plugin, set the default -`PackageInfoPlatform` by calling -`PackageInfoPlatform.instance = MyPlatformPackageInfo()`. +## Usage -# Note on breaking changes - -Strongly prefer non-breaking changes (such as adding a method to the interface) -over breaking changes for this package. - -See https://flutter.dev/go/platform-interface-breaking-changes for a discussion -on why a less-clean interface is preferable to a breaking change. - -[1]: ../package_info_plus -[2]: lib/package_info_platform_interface.dart \ No newline at end of file +This package is already included as part of the `package_info_plus` package dependency, and will +be included when using `package_info_plus` as normal. diff --git a/packages/package_info_plus_web/README.md b/packages/package_info_plus_web/README.md index aa15a26f46..6df1a8da9c 100644 --- a/packages/package_info_plus_web/README.md +++ b/packages/package_info_plus_web/README.md @@ -1,38 +1,12 @@ -# package_info_plus_web +# Package Info Plus Web -The web implementation of [`package_info_plus`][1]. +[![Flutter Community: package_info_plus_web](https://fluttercommunity.dev/_github/header/package_info_plus_web)](https://github.com/fluttercommunity/community) -## Usage -### Using this package -To use this plugin please upgrade to latest version of flutter master channel -### Import the package - -This package has been endorsed, meaning that you only need to add `package_info_plus` -as a dependency in your `pubspec.yaml`. It will be automatically included in your app -when you depend on `package:package_info_plus`. - -This is what the above means to your `pubspec.yaml`: +[![pub package](https://img.shields.io/pub/v/package_info_plus_web.svg)](https://pub.dev/packages/package_info_plus_web) -```yaml -... -dependencies: - ... - package_info_plus: ^0.4.5 - ... -``` +The Web implementation of [`package_info_plus`](https://pub.dev/packages/package_info_plus). -If you wish to use the web package only, you can add `package_info_plus_web` as a -dependency: - -```yaml -... -dependencies: - ... - package_info_plus_web: ^0.0.1 - ... -``` - -### Use the plugin -Once you have the correct `package_info_plus` dependency in your pubspec, you should be able to use package:package_info_plus as normal, even from your web code. +## Usage -[1]: ../package_info_plus +This package is already included as part of the `package_info_plus` package dependency, and will +be included when using `package_info_plus` as normal. diff --git a/packages/sensors_plus/README.md b/packages/sensors_plus/README.md index eaba1347d1..7240422c96 100644 --- a/packages/sensors_plus/README.md +++ b/packages/sensors_plus/README.md @@ -3,16 +3,8 @@ [![pub package](https://img.shields.io/pub/v/sensors_plus.svg)](https://pub.dev/packages/sensors_plus) -**Please set your constraint to `sensors: '>=0.4.y+x <2.0.0'`** - -## Backward compatible 1.0.0 version is coming -The sensors_plus plugin has reached a stable API, we guarantee that version `1.0.0` will be backward compatible with `0.4.y+z`. -Please use `sensors: '>=0.4.y+x <2.0.0'` as your dependency constraint to allow a smoother ecosystem migration. -For more details see: https://github.com/flutter/flutter/wiki/Package-migration-to-1.0.0 - A Flutter plugin to access the accelerometer and gyroscope sensors. - ## Usage To use this plugin, add `sensors_plus` as a [dependency in your pubspec.yaml diff --git a/packages/sensors_plus_platform_interface/README.md b/packages/sensors_plus_platform_interface/README.md index 2b204f9165..01bd1838fb 100644 --- a/packages/sensors_plus_platform_interface/README.md +++ b/packages/sensors_plus_platform_interface/README.md @@ -1,5 +1,12 @@ -# sensors_plus_platform_interface +# Sensors Plus Platform Interface -Platform interface implementation of [sensors_plus][1] +[![Flutter Community: sensors_plus_platform_interface](https://fluttercommunity.dev/_github/header/sensors_plus_platform_interface)](https://github.com/fluttercommunity/community) -[1]: https://github.com/fluttercommunity/sensors_plus \ No newline at end of file +[![pub package](https://img.shields.io/pub/v/sensors_plus_platform_interface.svg)](https://pub.dev/packages/sensors_plus_platform_interface) + +A common platform interface for [`sensors_plus`](https://pub.dev/packages/sensors_plus). + +## Usage + +This package is already included as part of the `sensors_plus` package dependency, and will +be included when using `sensors_plus` as normal. diff --git a/packages/sensors_plus_web/README.md b/packages/sensors_plus_web/README.md index 161b61a167..8b997ae29f 100644 --- a/packages/sensors_plus_web/README.md +++ b/packages/sensors_plus_web/README.md @@ -1,5 +1,12 @@ -# sensors_plus_web +# Sensors Plus Web -Web implementation of [sensors_plus][1] +[![Flutter Community: sensors_plus_web](https://fluttercommunity.dev/_github/header/sensors_plus_web)](https://github.com/fluttercommunity/community) -[1]: https://github.com/fluttercommunity/sensors_plus +[![pub package](https://img.shields.io/pub/v/sensors_plus_web.svg)](https://pub.dev/packages/sensors_plus_web) + +The Web implementation of [`sensors_plus`](https://pub.dev/packages/sensors_plus). + +## Usage + +This package is already included as part of the `sensors_plus` package dependency, and will +be included when using `sensors_plus` as normal. diff --git a/packages/share_plus_platform_interface/README.md b/packages/share_plus_platform_interface/README.md index a8e03b65e5..7c5f600dfd 100644 --- a/packages/share_plus_platform_interface/README.md +++ b/packages/share_plus_platform_interface/README.md @@ -1,26 +1,12 @@ -# share_plus_platform_interface +# Share Plus Platform Interface -A common platform interface for the [`share_plus`][1] plugin. +[![Flutter Community: share_plus_platform_interface](https://fluttercommunity.dev/_github/header/share_plus_platform_interface)](https://github.com/fluttercommunity/community) -This interface allows platform-specific implementations of the `share_plus` -plugin, as well as the plugin itself, to ensure they are supporting the -same interface. +[![pub package](https://img.shields.io/pub/v/share_plus_platform_interface.svg)](https://pub.dev/packages/share_plus_platform_interface) -# Usage +A common platform interface for [`share_plus`](https://pub.dev/packages/share_plus). -To implement a new platform-specific implementation of `share_plus`, extend -[`SharePlatform`][2] with an implementation that performs the -platform-specific behavior, and when you register your plugin, set the default -`SharePlatform` by calling -`SharePlatform.instance = MyPlatformShare()`. +## Usage -# Note on breaking changes - -Strongly prefer non-breaking changes (such as adding a method to the interface) -over breaking changes for this package. - -See https://flutter.dev/go/platform-interface-breaking-changes for a discussion -on why a less-clean interface is preferable to a breaking change. - -[1]: ../ -[2]: lib/share_plus_platform_interface.dart +This package is already included as part of the `share_plus` package dependency, and will +be included when using `share_plus` as normal.