diff --git a/README.md b/README.md index ee967261d9..b5f07d4427 100644 --- a/README.md +++ b/README.md @@ -28,7 +28,7 @@ dev_dependencies: flutter_test: sdk: flutter - flutter_launcher_icons: "^0.5.2" + flutter_launcher_icons: "^0.6.0" ``` 2. Within the same pubspec.yaml file, add flutter_icons config section. @@ -40,7 +40,7 @@ dev_dependencies: flutter_test: sdk: flutter - flutter_launcher_icons: "^0.5.2" + flutter_launcher_icons: "^0.6.0" flutter_icons: android: true @@ -53,43 +53,22 @@ flutter_icons: ``` ### Attributes: -``` -android/ios - -- True: Override the default existing Flutter launcher icon for the platform specified -- False: Ignore making launcher icons for this platform -- "Your Icon Name Here": This will generate a new launcher icons for the platform with the name you specify, without removing the old default existing Flutter launcher icon. - - -image_path - -- The location of the icon image file which you want to use as the app launcher icon - - -image_path_android - -- The location of the icon image file specific for Android platform (optional - if not defined then the image_path is used) +- `android`/`ios` + - `true`: Override the default existing Flutter launcher icon for the platform specified + - `false`: Ignore making launcher icons for this platform + - `icon/path/here.png`: This will generate a new launcher icons for the platform with the name you specify, without removing the old default existing Flutter launcher icon. -image_path_ios +- `image_path`: The location of the icon image file which you want to use as the app launcher icon -- The location of the icon image file specific for iOS platform (optional - if not defined then the image_path is used) +- `image_path_android`: The location of the icon image file specific for Android platform (optional - if not defined then the image_path is used) +- `image_path_ios`: The location of the icon image file specific for iOS platform (optional - if not defined then the image_path is used) -ADAPTIVE ICONS +- Adaptive icons: The next two attributes are only necessary if you want to have an adaptive icon for the Android app of your Flutter project. + - `adaptive_icon_background`: The color which will be used to fill out the background of the adaptive icon. + - `adaptive_icon_foreground`: The image asset which will be used for the icon foreground of the adaptive icon -The next two attributes are only necessary if you want to have an adaptive icon for the Android app of your Flutter project. - - -adaptive_icon_background - -- The color which will be used to fill out the background of the adaptive icon. - - -adaptive_icon_foreground - -- The image asset which will be used for the icon foreground of the adaptive icon -``` 3. Run the command to generate the icons