diff options
Diffstat (limited to 'docs')
-rw-r--r-- | docs/backend_api.md | 2 | ||||
-rw-r--r-- | docs/configuration.md | 4 | ||||
-rw-r--r-- | docs/frontend_api.md | 2 | ||||
-rw-r--r-- | docs/integration.md | 8 | ||||
-rw-r--r-- | docs/updating.md | 10 |
5 files changed, 13 insertions, 13 deletions
diff --git a/docs/backend_api.md b/docs/backend_api.md index e4f07df..a9d29ac 100644 --- a/docs/backend_api.md +++ b/docs/backend_api.md | |||
@@ -1,6 +1,6 @@ | |||
1 | # Backend API | 1 | # Backend API |
2 | 2 | ||
3 | Provides a set of helper functions to integrate the recipe into [Ferdi](https://getferdi.com). | 3 | Provides a set of helper functions to integrate the recipe into [Ferdi](https://ferdium.org). |
4 | 4 | ||
5 | ## Ferdi Backend Class Methods | 5 | ## Ferdi Backend Class Methods |
6 | 6 | ||
diff --git a/docs/configuration.md b/docs/configuration.md index ab496c6..a53c99d 100644 --- a/docs/configuration.md +++ b/docs/configuration.md | |||
@@ -1,6 +1,6 @@ | |||
1 | # Integration Config | 1 | # Integration Config |
2 | 2 | ||
3 | A [Ferdi](https://getferdi.com) recipe is a node module. In order to learn more about node modules and their configuration check the official [Node.js documentation](https://nodejs.org/api/modules.html) / [npm package.json documentation](https://docs.npmjs.com/files/package.json). | 3 | A [Ferdi](https://ferdium.org) recipe is a node module. In order to learn more about node modules and their configuration check the official [Node.js documentation](https://nodejs.org/api/modules.html) / [npm package.json documentation](https://docs.npmjs.com/files/package.json). |
4 | 4 | ||
5 | ## Table of Contents | 5 | ## Table of Contents |
6 | 6 | ||
@@ -83,4 +83,4 @@ Services like Outlook differentiate between favorites vs other folders. Setting | |||
83 | 83 | ||
84 | ## Example | 84 | ## Example |
85 | 85 | ||
86 | The [mattermost configuration](https://github.com/getferdi/recipes/blob/master/recipes/mattermost/package.json) is a typical example. | 86 | The [mattermost configuration](https://github.com/ferdium/ferdium-recipes/blob/master/recipes/mattermost/package.json) is a typical example. |
diff --git a/docs/frontend_api.md b/docs/frontend_api.md index 5bf4ebd..35b0918 100644 --- a/docs/frontend_api.md +++ b/docs/frontend_api.md | |||
@@ -35,7 +35,7 @@ | |||
35 | 35 | ||
36 | # Frontend API | 36 | # Frontend API |
37 | 37 | ||
38 | Provides a set of helper functions to integrate the service into [Ferdi](https://getferdi.com). | 38 | Provides a set of helper functions to integrate the service into [Ferdi](https://ferdium.org). |
39 | 39 | ||
40 | ## Ferdi Class Methods | 40 | ## Ferdi Class Methods |
41 | 41 | ||
diff --git a/docs/integration.md b/docs/integration.md index 9e9a547..1115454 100644 --- a/docs/integration.md +++ b/docs/integration.md | |||
@@ -6,9 +6,9 @@ A Ferdi recipe is basically nothing else than a node module and is currently ini | |||
6 | 6 | ||
7 | > ℹ️ New to Ferdi recipes and Electron? Then we recommend you read Jake Lee's ["Super simple guide to adding a new Ferdi service recipe"](https://blog.jakelee.co.uk/super-simple-guide-to-adding-a-new-ferdi-service-recipe/) which gives you an easy step-by-step guide on how to create and publish your recipe! | 7 | > ℹ️ New to Ferdi recipes and Electron? Then we recommend you read Jake Lee's ["Super simple guide to adding a new Ferdi service recipe"](https://blog.jakelee.co.uk/super-simple-guide-to-adding-a-new-ferdi-service-recipe/) which gives you an easy step-by-step guide on how to create and publish your recipe! |
8 | 8 | ||
9 | > ℹ️ 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 | 9 | > ℹ️ 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/ferdium/ferdium-recipes/issues/new and we can help you develop, test and publish your recipe |
10 | 10 | ||
11 | > If you want to update an existing recipe, please refer to [updating.md](https://github.com/getferdi/recipes/blob/master/docs/updating.md) instead | 11 | > If you want to update an existing recipe, please refer to [updating.md](https://github.com/ferdium/ferdium-recipes/blob/master/docs/updating.md) instead |
12 | 12 | ||
13 | ## Table of Contents | 13 | ## Table of Contents |
14 | 14 | ||
@@ -34,7 +34,7 @@ We have also created a nice script that already does 50% of the work for you - y | |||
34 | ## Create a recipe | 34 | ## Create a recipe |
35 | 35 | ||
36 | 1. Fork this repository on GitHub. You can do this by clicking the "Fork" button in the top right corner | 36 | 1. Fork this repository on GitHub. You can do this by clicking the "Fork" button in the top right corner |
37 | 2. Clone your forked repository. Normally, you can do this by running `git clone https://github.com/<Your GitHub Username>/recipes.git` in your terminal. You may also use a Git GUI or the GitHub Website for this. | 37 | 2. Clone your forked repository. Normally, you can do this by running `git clone https://github.com/<Your GitHub Username>/ferdium-recipes.git` in your terminal. You may also use a Git GUI or the GitHub Website for this. |
38 | 3. (Optional, if you want to use our creation script) Install its dependencies via the terminal: | 38 | 3. (Optional, if you want to use our creation script) Install its dependencies via the terminal: |
39 | 39 | ||
40 | ```Bash | 40 | ```Bash |
@@ -212,7 +212,7 @@ In order to debug your service integration, open Ferdi and use the shortcut `Cmd | |||
212 | 212 | ||
213 | ## Publishing | 213 | ## Publishing |
214 | 214 | ||
215 | Ferdi uses its recipe repository at <https://github.com/getferdi/recipes> to publish recipes to all clients. | 215 | Ferdi uses its recipe repository at <https://github.com/ferdium/ferdium-recipes> to publish recipes to all clients. |
216 | 216 | ||
217 | Publishing your recipes to Ferdi is super easy! When you used our recipe creation script, we have created a folder for your recipe inside Ferdi's internal folders (the one that got automatically opened after you ran our script). | 217 | Publishing your recipes to Ferdi is super easy! When you used our recipe creation script, we have created a folder for your recipe inside Ferdi's internal folders (the one that got automatically opened after you ran our script). |
218 | 218 | ||
diff --git a/docs/updating.md b/docs/updating.md index f18da33..f840f50 100644 --- a/docs/updating.md +++ b/docs/updating.md | |||
@@ -7,9 +7,9 @@ If you want to improve or update an existing recipe, please follow this guide. | |||
7 | We highly suggest that you implement and test your updates to the recipe inside Ferdi before implementing them into the recipe repository. This will save you time on debugging and repackaging the recipe later. | 7 | We highly suggest that you implement and test your updates to the recipe inside Ferdi before implementing them into the recipe repository. This will save you time on debugging and repackaging the recipe later. |
8 | 8 | ||
9 | You can find the recipe source Ferdi uses at: | 9 | You can find the recipe source Ferdi uses at: |
10 | * Mac: `~/Library/Application Support/Ferdi/recipes/<recipe id>/` | 10 | * Mac: `~/Library/Application Support/Ferdium/recipes/<recipe id>/` |
11 | * Windows: `%appdata%/Ferdi/recipes/<recipe id>/` | 11 | * Windows: `%appdata%/Ferdium/recipes/<recipe id>/` |
12 | * Linux: `~/.config/Ferdi/recipes/<recipe id>` | 12 | * Linux: `~/.config/Ferdium/recipes/<recipe id>` |
13 | 13 | ||
14 | > If you can't find the recipe's folder, please make sure that you have created a service inside Ferdi with that recipe - otherwise Ferdi will not load it into the folder | 14 | > If you can't find the recipe's folder, please make sure that you have created a service inside Ferdi with that recipe - otherwise Ferdi will not load it into the folder |
15 | 15 | ||
@@ -17,7 +17,7 @@ After changing the files in that folder, you can reload the service inside Ferdi | |||
17 | 17 | ||
18 | ## 2. Setting up the recipe repository | 18 | ## 2. Setting up the recipe repository |
19 | 19 | ||
20 | Simply fork https://github.com/getferdi/recipes. You may also want to clone the repository to your computer to edit it locally. | 20 | Simply fork https://github.com/ferdium/ferdium-recipes. You may also want to clone the repository to your computer to edit it locally. |
21 | 21 | ||
22 | ## 3. Updating the recipe inside the repository | 22 | ## 3. Updating the recipe inside the repository |
23 | 23 | ||
@@ -33,4 +33,4 @@ Ferdi uses this version to determine if it should update the local copy of the r | |||
33 | 33 | ||
34 | This might be the __most important step__ of this guide. You'll need to run the `pnpm run package` command to ensure that all validation checks are run. | 34 | This might be the __most important step__ of this guide. You'll need to run the `pnpm run package` command to ensure that all validation checks are run. |
35 | 35 | ||
36 | ## 6. Commit your changes and create a PR to <https://github.com/getferdi/recipes> | 36 | ## 6. Commit your changes and create a PR to <https://github.com/ferdium/ferdium-recipes> |