Skip to content

Commit e888945

Browse files
committed
docs: update readme
1 parent 42f868e commit e888945

File tree

2 files changed

+19
-11
lines changed

2 files changed

+19
-11
lines changed

README.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,15 @@
1-
# App Widget v0.0.1
2-
App Widget plugin for flutter
1+
# App Widget
2+
App Widget / Home Screen widget plugin for flutter app
33

44
## Usage
55

66
Please see `app_widget` subdirectory for the usage documentation.
77

88
## Plaform Support
9-
- [x] Android - In development
10-
- [ ] iOS - TBD
9+
10+
| Android | iOS |
11+
| :-----: | :-: |
12+
| ✔️ | |
1113

1214
## Project Structure
1315

@@ -24,6 +26,8 @@ plugin.
2426
4. Create a PR
2527

2628
## Android Integration Test
29+
- Make sure to run on the latest and minSdk supported
30+
2731
in `app_widget/example/integration_test/app_widget_test.dart`
2832

2933
```sh

app_widget/README.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,17 @@ flutter app widget
44

55
## Getting Started
66

7-
## Platform support
8-
- [x] Android
9-
- [ ] iOS
7+
Since flutter engine are build on android activity, we cannot directly build
8+
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
10+
going back and forth to native.
11+
## Plaform Support
12+
13+
| Android | iOS |
14+
| :-----: | :-: |
15+
| ✔️ | |
1016

1117
### Android
12-
Since flutter engine are build on android activity, we cannot directly build
13-
the the widget interface using flutter. Hence it need to be build using XML
14-
the android way.
1518

1619
This plugin introduce some api from the android native and provide some suggestion on how
1720
to include an app widget with you flutter application.
@@ -204,5 +207,6 @@ TODO
204207

205208
## Checklist
206209
- [x] Unit Test
207-
- [ ] Readme documentation
210+
- [ ] update documentation
208211
- [ ] Update example app
212+
- [ ] Update Screenshot

0 commit comments

Comments
 (0)