Skip to content

Commit 9916c77

Browse files
committed
chore: update readme
1 parent e5a899d commit 9916c77

File tree

6 files changed

+15
-21
lines changed

6 files changed

+15
-21
lines changed

app_widget/README.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,10 @@
1-
# app_widget
2-
3-
flutter app widget
4-
5-
## Getting Started
1+
# App Widget
62

73
Since flutter engine are build on android activity, we cannot directly build
84
the the widget interface using flutter. Hence it need to be build using the native
9-
way. This plugin attempt to exposed as much useful API to flutter to reduce
5+
way. This plugin attempt to exposed as much useful API and callback to flutter to reduce
106
going back and forth to native.
7+
118
## Plaform Support
129

1310
| Android | iOS |

app_widget/pubspec.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
name: app_widget
2-
description: flutter app widget
2+
description: Flutter plugin that provide useful app widget api and callback into flutter
33
version: 0.0.4
44
homepage: https://noxasch.tech/
55
repository: https://github.com/noxasch/flutter_app_widget/tree/master/app_widget

app_widget_android/README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
# app_widget_android
22

3-
This package are meant to use by app_widget. If you are using this on it's own, you
4-
are on your own.
3+
Android implementation for [app_widget](https://pub.dev/packages/app_widget) plugin. This package are not meant to be used
4+
on it's own.
5+
56
## Getting Started
67

78
This project is a starting point for a Flutter

app_widget_android/pubspec.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
name: app_widget_android
2-
description: flutter app widget
2+
description: Android implementation for app_widget plugin
33
version: 0.0.4
44
homepage: https://noxasch.tech/
55
repository: https://github.com/noxasch/flutter_app_widget/tree/master/app_widget_android
Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,11 @@
11
# app_widget_platform_interface
22

3-
flutter app widget
3+
Common platform interface for [app_widget](https://pub.dev/packages/app_widget) plugin.
44

5-
## Getting Started
5+
## Usage
66

7-
This project is a starting point for a Flutter
8-
[plug-in package](https://flutter.dev/developing-packages/),
9-
a specialized package that includes platform-specific implementation code for
10-
Android and/or iOS.
11-
12-
For help getting started with Flutter development, view the
13-
[online documentation](https://flutter.dev/docs), which offers tutorials,
14-
samples, guidance on mobile development, and a full API reference.
7+
To implement a new platform-specific, extend `AppWidgetPlatform` with a `registerWith` as static method that set default
8+
`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
9+
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`.
1510

11+
We try to avoid breaking changes at all. Try to reuse the existing interface to keep the api clean whenever possible.

app_widget_platform_interface/pubspec.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
name: app_widget_platform_interface
2-
description: flutter app widget
2+
description: Common platform interface for app_widget plugin.
33
version: 0.0.3
44
homepage: https://noxasch.tech/
55
repository: https://github.com/noxasch/flutter_app_widget/tree/master/app_widget_platform_interface

0 commit comments

Comments
 (0)