Skip to content

Commit

Permalink
docs: update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
noxasch committed Sep 24, 2022
1 parent c1f1bdc commit d7e3e83
Showing 1 changed file with 15 additions and 2 deletions.
17 changes: 15 additions & 2 deletions app_widget/README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,25 @@
# App Widget

[![platform-interface](https://github.com/noxasch/flutter_app_widget/actions/workflows/interface.yaml/badge.svg)](https://github.com/noxasch/flutter_app_widget/actions/workflows/interface.yaml)
[![android](https://github.com/noxasch/flutter_app_widget/actions/workflows/android.yaml/badge.svg)](https://github.com/noxasch/flutter_app_widget/actions/workflows/android.yaml)
[![build](https://github.com/noxasch/flutter_app_widget/actions/workflows/main.yaml/badge.svg)](https://github.com/noxasch/flutter_app_widget/actions/workflows/main.yaml)

This plugin attempt to exposed as much useful API and callback to flutter to reduce
going back and forth to native and make buidling app widget / home screen widget easier.
going back and forth to native and make building app widget / home screen widget easier
and can be manage fully from flutter side keeping app codebase logic in flutter.


| | |
| --- | --- |
|![screen_shot](assets/screen_shot.webp) | ![gif](assets/example_app.gif) |

## Caveat

Configuring or opening a screen from the widget is slower (unless the app is still active in the background)
compare to native because we need to wait for flutter engine to start. Hence as you can see from the gif there
is some delay and without the launch screen we can notice this delay. Howver on Android, most likely your
app start time will going to improve over time except during the first time user open it after an update.
So this shouldn't be an issue. Although we can notice significant delay in old phone and in debug mode.

## Plaform Support

Expand Down Expand Up @@ -488,6 +501,6 @@ void main() {
- [x] update documentation to cover api usage
- [x] Test example
- [x] Update example app
- [ ] Github Action CI
- [x] Github Action Workflow (CI)
- [x] Update Screenshot
- [ ] iOS support

0 comments on commit d7e3e83

Please sign in to comment.