Skip to content

Commit

Permalink
Update README with proper versions and better attributes list (#42)
Browse files Browse the repository at this point in the history
  • Loading branch information
Cretezy authored and MarkOSullivan94 committed Aug 8, 2018
1 parent 81bb8f4 commit fe93a41
Showing 1 changed file with 12 additions and 33 deletions.
45 changes: 12 additions & 33 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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
Expand All @@ -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

Expand Down

0 comments on commit fe93a41

Please sign in to comment.