diff options
Diffstat (limited to 'docs/integration.md')
-rw-r--r-- | docs/integration.md | 17 |
1 files changed, 7 insertions, 10 deletions
diff --git a/docs/integration.md b/docs/integration.md index 360c722..769bde7 100644 --- a/docs/integration.md +++ b/docs/integration.md | |||
@@ -65,16 +65,13 @@ Every recipe needs a specific file structure in order to work as a Ferdi recipe | |||
65 | 65 | ||
66 | ### package.json | 66 | ### package.json |
67 | 67 | ||
68 | The package.json is structured like any other node module and allows to completely configure the service. | 68 | The `package.json` is structured like any other node module and allows to completely configure the service. |
69 | 69 | ||
70 | ```json | 70 | ```json |
71 | { | 71 | { |
72 | "id": "tweetdeck", | 72 | "id": "tweetdeck", |
73 | "name": "Tweetdeck", | 73 | "name": "Tweetdeck", |
74 | "version": "1.0.1", | 74 | "version": "1.0.1", |
75 | "description": "Tweetdeck", | ||
76 | "main": "index.js", | ||
77 | "author": "Stefan Malzner <stefan@adlk.io>", | ||
78 | "license": "MIT", | 75 | "license": "MIT", |
79 | "repository": "https://github.com/meetfranz/recipe-tweetdeck", | 76 | "repository": "https://github.com/meetfranz/recipe-tweetdeck", |
80 | "config": { | 77 | "config": { |
@@ -85,7 +82,7 @@ The package.json is structured like any other node module and allows to complete | |||
85 | 82 | ||
86 | To get more information about all the provided configuration flags, check the [config docs](configuration.md). | 83 | To get more information about all the provided configuration flags, check the [config docs](configuration.md). |
87 | 84 | ||
88 | Please note that the fields `id`, `name`, `version` and `config` and required. | 85 | Please note that the fields `id`, `name`, `version` and `config` are mandatory. |
89 | 86 | ||
90 | ### index.js | 87 | ### index.js |
91 | 88 | ||
@@ -130,7 +127,7 @@ Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_2) AppleWebKit/537.36 (KHTML, like | |||
130 | 127 | ||
131 | Some services may not be compatible with Ferdi adding it's signature to the user agent. | 128 | Some services may not be compatible with Ferdi adding it's signature to the user agent. |
132 | 129 | ||
133 | If you encounter such a service, you remove this signature with the following snippet of code | 130 | If you encounter such a service, please remove this signature with the following snippet of code |
134 | 131 | ||
135 | ```js | 132 | ```js |
136 | overrideUserAgent() { | 133 | overrideUserAgent() { |
@@ -151,7 +148,7 @@ overrideUserAgent() { | |||
151 | 148 | ||
152 | ### webview.js | 149 | ### webview.js |
153 | 150 | ||
154 | The webview.js is the actual script that will be loaded into the webview. Here you can do whatever you want to do in order perfectly integrate the service into Ferdi. For convenience, we have provided a very simple set of functions to set unread message badges (`Ferdi.setBadge()`) and inject CSS files (`Ferdi.injectCSS()`). | 151 | The `webview.js` is the actual script that will be loaded into the webview. Here you can do whatever you want to do in order perfectly integrate the service into Ferdi. For convenience, we have provided a very simple set of functions to set unread message badges (`Ferdi.setBadge()`) and inject CSS files (`Ferdi.injectCSS()`). |
155 | 152 | ||
156 | ```js | 153 | ```js |
157 | // orat.io integration | 154 | // orat.io integration |
@@ -176,17 +173,17 @@ To get more information about the provided functions, check the [API docs](front | |||
176 | 173 | ||
177 | ## Icons | 174 | ## Icons |
178 | 175 | ||
179 | 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. | 176 | In order to show every service icon crystal clear within the Ferdi UI, we require the icon in .svg (square, 1024x1024px) format. |
180 | 177 | ||
181 | ## Dark Mode | 178 | ## Dark Mode |
182 | 179 | ||
183 | 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. | 180 | 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. |
184 | 181 | ||
185 | Recipe Dark Mode is only supported by Ferdi 5.0.0-beta.19+ | 182 | Recipe Dark Mode is only supported by Ferdi 5.0.0-beta.19+. Even then, certain services do not allow clients like Ferdi to override these styles (an example of this is google calendar). |
186 | 183 | ||
187 | ## Debugging | 184 | ## Debugging |
188 | 185 | ||
189 | In order to debug your service integration, open Ferdi and use the shortcut `Cmd/Ctrl+Alt+Shift+i` to open the recipes developer tools. | 186 | In order to debug your service integration, open Ferdi and use the shortcut `Cmd/Ctrl+Alt+Shift+I` to open the recipes developer tools. |
190 | 187 | ||
191 | ## Publishing | 188 | ## Publishing |
192 | 189 | ||