Skip to content

Commit 7850064

Browse files
RatakondalaArunMarkOSullivan94
authored andcommitted
docs(web): added web documentation
1 parent 168b0b8 commit 7850064

File tree

1 file changed

+12
-1
lines changed

1 file changed

+12
-1
lines changed

README.md

+12-1
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,11 @@ flutter_icons:
2121
android: "launcher_icon"
2222
ios: true
2323
image_path: "assets/icon/icon.png"
24+
web:
25+
generate: true
26+
image_path: "path/to/image.png"
27+
background_color: "#hexcode"
28+
theme_color: "#hexcode"
2429
```
2530
2631
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
6267

6368
- `image_path_ios`: The location of the icon image file specific for iOS platform (optional - if not defined then the image_path is used)
6469

65-
_Note: iOS icons should [fill the entire image](https://stackoverflow.com/questions/26014461/black-border-on-my-ios-icon) and not contain transparent borders._
70+
- `web`: Add web related configs
71+
- `generate`: Specifies weather to generate icons for this platform or not
72+
- `image_path`: Path to web icon.png
73+
- `background_color`: Updates *background_color* in `web/manifest.json`
74+
- `theme_color`: Updates *theme_color* in `web/manifest.json`
75+
76+
*Note: iOS icons should [fill the entire image](https://stackoverflow.com/questions/26014461/black-border-on-my-ios-icon) and not contain transparent borders.*
6677

6778
The next two attributes are only used when generating Android launcher icon
6879

0 commit comments

Comments
 (0)