From 7850064ad347a31b8b178a1b2ffb7ec73caa0b5f Mon Sep 17 00:00:00 2001 From: Ratakondala Arun Date: Sat, 23 Jul 2022 17:36:09 +0530 Subject: [PATCH] docs(web): added web documentation --- README.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index ce3bf9a3c1..6a7caacbc3 100644 --- a/README.md +++ b/README.md @@ -21,6 +21,11 @@ flutter_icons: android: "launcher_icon" ios: true image_path: "assets/icon/icon.png" + web: + generate: true + image_path: "path/to/image.png" + background_color: "#hexcode" + theme_color: "#hexcode" ``` If you name your configuration file something other than `flutter_launcher_icons.yaml` or `pubspec.yaml` you will need to specify @@ -62,7 +67,13 @@ Shown below is the full list of attributes which you can specify within your Flu - `image_path_ios`: The location of the icon image file specific for iOS platform (optional - if not defined then the image_path is used) -_Note: iOS icons should [fill the entire image](https://stackoverflow.com/questions/26014461/black-border-on-my-ios-icon) and not contain transparent borders._ +- `web`: Add web related configs + - `generate`: Specifies weather to generate icons for this platform or not + - `image_path`: Path to web icon.png + - `background_color`: Updates *background_color* in `web/manifest.json` + - `theme_color`: Updates *theme_color* in `web/manifest.json` + +*Note: iOS icons should [fill the entire image](https://stackoverflow.com/questions/26014461/black-border-on-my-ios-icon) and not contain transparent borders.* The next two attributes are only used when generating Android launcher icon