diff --git a/README.md b/README.md index 7952843..33eb840 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,15 @@ -# App Widget v0.0.1 -App Widget plugin for flutter +# App Widget +App Widget / Home Screen widget plugin for flutter app ## Usage Please see `app_widget` subdirectory for the usage documentation. ## Plaform Support -- [x] Android - In development -- [ ] iOS - TBD + +| Android | iOS | +| :-----: | :-: | +| ✔️ | | ## Project Structure @@ -24,6 +26,8 @@ plugin. 4. Create a PR ## Android Integration Test +- Make sure to run on the latest and minSdk supported + in `app_widget/example/integration_test/app_widget_test.dart` ```sh diff --git a/app_widget/README.md b/app_widget/README.md index e5bf7d9..4335a9d 100644 --- a/app_widget/README.md +++ b/app_widget/README.md @@ -4,14 +4,17 @@ flutter app widget ## Getting Started -## Platform support -- [x] Android -- [ ] iOS +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 +going back and forth to native. +## Plaform Support + +| Android | iOS | +| :-----: | :-: | +| ✔️ | | ### Android -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 XML -the android way. This plugin introduce some api from the android native and provide some suggestion on how to include an app widget with you flutter application. @@ -204,5 +207,6 @@ TODO ## Checklist - [x] Unit Test -- [ ] Readme documentation +- [ ] update documentation - [ ] Update example app +- [ ] Update Screenshot