diff --git a/app_widget/README.md b/app_widget/README.md index 658845d..012208f 100644 --- a/app_widget/README.md +++ b/app_widget/README.md @@ -1,13 +1,10 @@ -# app_widget - -flutter app widget - -## Getting Started +# App Widget Since flutter engine are build on android activity, we cannot directly build the the widget interface using flutter. Hence it need to be build using the native -way. This plugin attempt to exposed as much useful API to flutter to reduce +way. This plugin attempt to exposed as much useful API and callback to flutter to reduce going back and forth to native. + ## Plaform Support | Android | iOS | diff --git a/app_widget/pubspec.yaml b/app_widget/pubspec.yaml index 7693eda..a0208b6 100644 --- a/app_widget/pubspec.yaml +++ b/app_widget/pubspec.yaml @@ -1,5 +1,5 @@ name: app_widget -description: flutter app widget +description: Flutter plugin that provide useful app widget api and callback into flutter version: 0.0.4 homepage: https://noxasch.tech/ repository: https://github.com/noxasch/flutter_app_widget/tree/master/app_widget diff --git a/app_widget_android/README.md b/app_widget_android/README.md index 1203689..4b965b0 100644 --- a/app_widget_android/README.md +++ b/app_widget_android/README.md @@ -1,7 +1,8 @@ # app_widget_android -This package are meant to use by app_widget. If you are using this on it's own, you -are on your own. +Android implementation for [app_widget](https://pub.dev/packages/app_widget) plugin. This package are not meant to be used +on it's own. + ## Getting Started This project is a starting point for a Flutter diff --git a/app_widget_android/pubspec.yaml b/app_widget_android/pubspec.yaml index ac030b3..c245c49 100644 --- a/app_widget_android/pubspec.yaml +++ b/app_widget_android/pubspec.yaml @@ -1,5 +1,5 @@ name: app_widget_android -description: flutter app widget +description: Android implementation for app_widget plugin version: 0.0.4 homepage: https://noxasch.tech/ repository: https://github.com/noxasch/flutter_app_widget/tree/master/app_widget_android diff --git a/app_widget_platform_interface/README.md b/app_widget_platform_interface/README.md index 88b65d4..013ffbf 100644 --- a/app_widget_platform_interface/README.md +++ b/app_widget_platform_interface/README.md @@ -1,15 +1,11 @@ # app_widget_platform_interface -flutter app widget + Common platform interface for [app_widget](https://pub.dev/packages/app_widget) plugin. -## 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. +To implement a new platform-specific, extend `AppWidgetPlatform` with a `registerWith` as static method that set default +`AppWidgetPlatform.instance = AppWidgetMyPlatform();`. And then create another class `AppWidgetMyPlatformlugin` with an implementation that performs the platform-specific behavior. Finally add your platform initialization in AppWidgetPlugin private +constructor to reinstantiate with the platform specific implementation `AppWidgetPlatform.instance = AppWidgetMyPlatformPlugin();` when the app run. This is because the plugin registrar will register the first intance before `FlutterWidgetBindings.ensureInitialized()` and will throw an error if we try to access any `methodChannel`. +We try to avoid breaking changes at all. Try to reuse the existing interface to keep the api clean whenever possible. diff --git a/app_widget_platform_interface/pubspec.yaml b/app_widget_platform_interface/pubspec.yaml index edf77e0..bb83d2f 100644 --- a/app_widget_platform_interface/pubspec.yaml +++ b/app_widget_platform_interface/pubspec.yaml @@ -1,5 +1,5 @@ name: app_widget_platform_interface -description: flutter app widget +description: Common platform interface for app_widget plugin. version: 0.0.3 homepage: https://noxasch.tech/ repository: https://github.com/noxasch/flutter_app_widget/tree/master/app_widget_platform_interface