Skip to content

Commit

Permalink
Merge pull request #46 from Alyxsqrd/patch-1
Browse files Browse the repository at this point in the history
Update README.md
  • Loading branch information
mrrhak committed Dec 27, 2023
2 parents af17989 + bd7e6de commit 2ff3e49
Showing 1 changed file with 18 additions and 18 deletions.
36 changes: 18 additions & 18 deletions README.md
Expand Up @@ -63,7 +63,7 @@

### Platform Support

| Android | iOS | MacOS | Web | Linux | Windows |
| Android | iOS | macOS | Web | Linux | Windows |
| :-----: | :-: | :---: | :-: | :---: | :-----: |
|||||||

Expand Down Expand Up @@ -117,56 +117,56 @@ In the above configuration, the package is setup to replace the existing launche

Shown below is the full list of attributes which you can specify within your Icons Launcher configuration.

| Icons Launcher Option | Type | Default | Description |
| --------------------- | ------ | ------- | ------------------------------------------- |
| `image_path` | String | `null` | The image file path |
| `platforms` | Object | `null` | Use for specific platform to generate icons |
| Icons Launcher Option | Type | Default | Description |
| --------------------- | ------ | ------- | -------------------------------------------- |
| `image_path` | String | `null` | The image file path |
| `platforms` | Object | `null` | Use for specific platforms to generate icons |

---

| Platforms Option | Type | Default | Description |
| ---------------- | ------ | ------- | --------------------------------- |
| `android` | Object | `null` | Use for specific android platform |
| `ios` | Object | `null` | Use for specific android platform |
| `macos` | Object | `null` | Use for specific android platform |
| `windows` | Object | `null` | Use for specific android platform |
| `web` | Object | `null` | Use for specific android platform |
| `linux` | Object | `null` | Use for specific android platform |
| `android` | Object | `null` | Use for specific Android platform |
| `ios` | Object | `null` | Use for specific iOS platform |
| `macos` | Object | `null` | Use for specific macOS platform |
| `windows` | Object | `null` | Use for specific Windows platform |
| `web` | Object | `null` | Use for specific Web platform |
| `linux` | Object | `null` | Use for specific Linux platform |

| Android Option | Type | Default | Description |
| --------------------------- | ------- | ------- | -------------------------------------------------------------------- |
| `enable` | Boolean | `false` | Use for enable android platform |
| `enable` | Boolean | `false` | Use for enable Android platform |
| `image_path` | String | `null` | The image file path |
| `adaptive_background_color` | String | `null` | Color for fill out the background of the adaptive icon (_"#ffffff"_) |
| `adaptive_background_image` | String | `null` | Image for fill out the background of the adaptive icon |
| `adaptive_foreground_image` | String | `null` | Image for the icon foreground of the adaptive icon |
| `adaptive_round_image` | String | `null` | Image for the round icon of the adaptive icon (optional) |
| `adaptive_monochrome_image` | String | `null` | Image for the monochrome version of the adaptive icon (optional) |

| IOS Option | Type | Default | Description |
| iOS Option | Type | Default | Description |
| ------------ | ------- | ------- | --------------------------- |
| `enable` | Boolean | `false` | Use for enable ios platform |
| `enable` | Boolean | `false` | Use for enable iOS platform |
| `image_path` | String | `null` | The image file path |

| Web Option | Type | Default | Description |
| -------------- | ------- | ------- | --------------------------- |
| `enable` | Boolean | `false` | Use for enable ios platform |
| `enable` | Boolean | `false` | Use for enable Web platform |
| `image_path` | String | `null` | The image file path |
| `favicon_path` | String | `null` | The image file path |

| macOS Option | Type | Default | Description |
| ------------ | ------- | ------- | ----------------------------- |
| `enable` | Boolean | `false` | Use for enable macos platform |
| `enable` | Boolean | `false` | Use for enable macOS platform |
| `image_path` | String | `null` | The image file path |

| Windows Option | Type | Default | Description |
| -------------- | ------- | ------- | ------------------------------- |
| `enable` | Boolean | `false` | Use for enable windows platform |
| `enable` | Boolean | `false` | Use for enable Windows platform |
| `image_path` | String | `null` | The image file path |

| Linux Option | Type | Default | Description |
| ------------ | ------- | ------- | ----------------------------- |
| `enable` | Boolean | `false` | Use for enable linux platform |
| `enable` | Boolean | `false` | Use for enable Linux platform |
| `image_path` | String | `null` | The image file path |

---
Expand Down

0 comments on commit 2ff3e49

Please sign in to comment.