diff --git a/CHANGELOG.md b/CHANGELOG.md index 24ee4e7b..a6a3a371 100755 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,6 +3,7 @@ ### BREAKING CHANGES - Plugin conversion to a [Federated Plugin](https://docs.flutter.dev/packages-and-plugins/developing-packages#federated-plugins) to better support multiple environments and implementations. +- Dart SDK min version `>= 2.17.0` - Android package name has been changed to `com.pichillilorenzo.flutter_inappwebview_android`. References to old package name `com.pichillilorenzo.flutter_inappwebview` should be updated, for example inside `AndroidManifest.xml` file: ` +This interface allows platform-specific implementations of the `flutter_inappwebview` +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 `flutter_inappwebview`, extend +[`InAppWebViewPlatform`](lib/src/inappwebview_platform.dart) with an implementation that performs the +platform-specific behavior, and when you register your plugin, set the default +`InAppWebViewPlatform` by calling +`InAppWebViewPlatform.instance = MyPlatformWebview()`. -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. \ No newline at end of file diff --git a/flutter_inappwebview_web/README.md b/flutter_inappwebview_web/README.md index ebefaaa9..125b34bc 100644 --- a/flutter_inappwebview_web/README.md +++ b/flutter_inappwebview_web/README.md @@ -1,15 +1,14 @@ -# flutter_inappwebview_web +# flutter\_inappwebview\_web -A new Flutter project. +The Web Platform [iframe](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/iframe) +implementation of [`flutter_inappwebview`][https://pub.dev/packages/flutter_inappwebview]. -## Getting Started +## Usage -This project is a starting point for a Flutter -[plug-in package](https://flutter.dev/developing-packages/), -a specialized package that includes platform-specific implementation code for -Android and/or iOS. - -For help getting started with Flutter development, view the -[online documentation](https://flutter.dev/docs), which offers tutorials, -samples, guidance on mobile development, and a full API reference. +This package is [endorsed][https://flutter.dev/docs/development/packages-and-plugins/developing-packages#endorsed-federated-plugin], +which means you can simply use `flutter_inappwebview` +normally. This package will be automatically included in your app when you do, +so you do not need to add it to your `pubspec.yaml`. +However, if you `import` this package to use any of its APIs directly, you +should add it to your `pubspec.yaml` as usual. \ No newline at end of file