Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
noxasch committed Sep 15, 2022
1 parent 42f868e commit e888945
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 11 deletions.
12 changes: 8 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -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

Expand All @@ -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
Expand Down
18 changes: 11 additions & 7 deletions app_widget/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -204,5 +207,6 @@ TODO

## Checklist
- [x] Unit Test
- [ ] Readme documentation
- [ ] update documentation
- [ ] Update example app
- [ ] Update Screenshot

0 comments on commit e888945

Please sign in to comment.