diff options
| author |  vantezzen <hello@vantezzen.io> | 2020-03-13 09:43:09 +0100 |
|---|---|---|
| committer | vantezzen <hello@vantezzen.io> | 2020-03-13 09:43:09 +0100 |
| commit | b097dca648c3b30e9e9941fbedb6dbc9c97bbcf0 (patch) | |
| tree | 7a5814e725cbc7daa580856e0508d03a8c226f8a /docs | |
| parent | Add information about community help (diff) | |
| download | ferdium-recipes-b097dca648c3b30e9e9941fbedb6dbc9c97bbcf0.tar.gz ferdium-recipes-b097dca648c3b30e9e9941fbedb6dbc9c97bbcf0.tar.zst ferdium-recipes-b097dca648c3b30e9e9941fbedb6dbc9c97bbcf0.zip | |
Improve integration guide
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/integration.md | 23 |
1 files changed, 13 insertions, 10 deletions
diff --git a/docs/integration.md b/docs/integration.md index 4fe898a..fa05ee3 100644 --- a/docs/integration.md +++ b/docs/integration.md | |||
| @@ -4,17 +4,20 @@ Recipes are responsible for providing the connection between the service itself | |||
| 4 | 4 | ||
| 5 | A Ferdi recipe is basically nothing else than a node module and is currently initialized on `dom-ready`. You access all of the [electron](http://electron.atom.io) modules as well. | 5 | A Ferdi recipe is basically nothing else than a node module and is currently initialized on `dom-ready`. You access all of the [electron](http://electron.atom.io) modules as well. |
| 6 | 6 | ||
| 7 | > ℹ️ If you have any problems packaging your recipes, if you are inexperienced with the tools used or have any other problems, we are here to help! Just open a new issue at https://github.com/getferdi/recipes/issues/new and we can help you develop, test and publish your recipe and can package the recipe for you if you don't feel like you are able to. | ||
| 7 | 8 | ||
| 8 | ## Table of Contents | 9 | ## Table of Contents |
| 9 | * [Installation](#user-content-installation) | 10 | - [Ferdi Recipe Documentation / Overview](#ferdi-recipe-documentation--overview) |
| 10 | * [Plugin structure](#user-content-recipe-structure) | 11 | - [Table of Contents](#table-of-contents) |
| 11 | * [Configuration (package.json)](#user-content-packagejson) | 12 | - [Installation](#installation) |
| 12 | * [Backend (index.js)](#user-content-indexjs) | 13 | - [Recipe structure](#recipe-structure) |
| 13 | * [Frontend (webview.js)](#user-content-webviewjs) | 14 | - [package.json](#packagejson) |
| 14 | * [Icons](#user-content-icons) | 15 | - [index.js](#indexjs) |
| 15 | * [Dark Mode](#user-content-dark-mode) | 16 | - [webview.js](#webviewjs) |
| 16 | * [Debugging](#user-content-debugging) | 17 | - [Icons](#icons) |
| 17 | * [Deployment](#user-content-deployment) | 18 | - [Dark Mode](#dark-mode) |
| 19 | - [Debugging](#debugging) | ||
| 20 | - [Publishing](#publishing) | ||
| 18 | 21 | ||
| 19 | ## Installation | 22 | ## Installation |
| 20 | 1. To install a new recipe for testing, download the recipe folder e.g `whatsapp` or simply create an empty one with the name of your new recipe (we recommend using a recipe like `whatsapp` as a template though). | 23 | 1. To install a new recipe for testing, download the recipe folder e.g `whatsapp` or simply create an empty one with the name of your new recipe (we recommend using a recipe like `whatsapp` as a template though). |
| @@ -131,7 +134,7 @@ In order to debug your service integration, open Ferdi and use the shortcut `Cmd | |||
| 131 | ### Publishing | 134 | ### Publishing |
| 132 | Ferdi uses its recipe repository at <https://github.com/getferdi/recipes> to publish recipes to all clients. | 135 | Ferdi uses its recipe repository at <https://github.com/getferdi/recipes> to publish recipes to all clients. |
| 133 | 136 | ||
| 134 | > ℹ️ If you have any problems packaging your recipes, if you are inexperienced with the tools used or have any other problems, we are here to help! Just open a new issue at https://github.com/getferdi/recipes/issues/new and we can help you develop, test and publish your recipe and can package the recipe for you if you don't feel like you are able to. | 137 | > Our scripts are designed to work best on Linux and macOS systems. If you want to use these scripts on Windows, you may need to use [WSL](https://docs.microsoft.com/en-US/windows/wsl/install-win10) in order for the scripts to function correctly. If you have problems with packaging, please open a new issue at https://github.com/getferdi/recipes/issues/new and we can package your recipe for you. |
| 135 | 138 | ||
| 136 | To add your own recipe to the repository: | 139 | To add your own recipe to the repository: |
| 137 | - If you already uploaded the recipe to GitHub: | 140 | - If you already uploaded the recipe to GitHub: |