diff options
| author |  Marco Lussetti <marcolussetti@users.noreply.github.com> | 2020-10-19 08:21:22 -0700 |
|---|---|---|
| committer | Marco Lussetti <marcolussetti@users.noreply.github.com> | 2020-10-21 18:51:53 -0700 |
| commit | 0c14c9550ff566c6289e7536cd8082b4f7c66d97 (patch) | |
| tree | a5aeb3fd4a1f3fc4c01fe27681288b36135ac305 /docs | |
| parent | Add GitHub Sponsors to FUNDING.yml (diff) | |
| download | ferdium-recipes-0c14c9550ff566c6289e7536cd8082b4f7c66d97.tar.gz ferdium-recipes-0c14c9550ff566c6289e7536cd8082b4f7c66d97.tar.zst ferdium-recipes-0c14c9550ff566c6289e7536cd8082b4f7c66d97.zip | |
docs: minor clarification (svg must be square)
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/integration.md | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/docs/integration.md b/docs/integration.md index 4de4953..45d3af7 100644 --- a/docs/integration.md +++ b/docs/integration.md | |||
| @@ -49,7 +49,7 @@ This command will automatically create the development recipe in the correct fol | |||
| 49 | ## Recipe structure | 49 | ## Recipe structure |
| 50 | Every recipe needs a specific file structure in order to work as a Ferdi recipe | 50 | Every recipe needs a specific file structure in order to work as a Ferdi recipe |
| 51 | 51 | ||
| 52 | * icon.svg - Icon for the service in SVG form | 52 | * icon.svg - Icon for the service in SVG form (must be square) |
| 53 | * icon.png - Icon for the service in PNG form (1024x1024px) | 53 | * icon.png - Icon for the service in PNG form (1024x1024px) |
| 54 | * index.js - Backend script, this script is NOT included in the service webview but only in Ferdi itself | 54 | * index.js - Backend script, this script is NOT included in the service webview but only in Ferdi itself |
| 55 | * package.json - Information about the recipe | 55 | * package.json - Information about the recipe |
| @@ -167,7 +167,7 @@ module.exports = (Ferdi) => { | |||
| 167 | To get more information about the provided functions, check the [API docs](frontend_api.md). | 167 | To get more information about the provided functions, check the [API docs](frontend_api.md). |
| 168 | 168 | ||
| 169 | ## Icons | 169 | ## Icons |
| 170 | In order to show every service icon crystal clear within the Ferdi UI, we require a .svg and .png in 1024x1024px. | 170 | In order to show every service icon crystal clear within the Ferdi UI, we require the icon in both .svg (square) and .png (square, 1024x1024px) formats. |
| 171 | 171 | ||
| 172 | ## Dark Mode | 172 | ## Dark Mode |
| 173 | You can provide a custom Dark Mode Theme for your recipes just by putting the `darkmode.css` into your recipe folder. Once the `darkmode.css` exists, you can enable the Dark Mode in your service settings. | 173 | You can provide a custom Dark Mode Theme for your recipes just by putting the `darkmode.css` into your recipe folder. Once the `darkmode.css` exists, you can enable the Dark Mode in your service settings. |