diff options
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 18 |
1 files changed, 2 insertions, 16 deletions
@@ -3,19 +3,5 @@ Recipes for Ferdi. | |||
3 | 3 | ||
4 | Copyright on these recipes is on their original creators. | 4 | Copyright on these recipes is on their original creators. |
5 | 5 | ||
6 | ## Adding your own recipes | 6 | ## Creating and adding your own recipes |
7 | After creating your own recipe using [Franz's guide](https://github.com/meetfranz/plugins/blob/master/docs/integration.md) you can add them to this repository. | 7 | Please refer to our documentation at https://github.com/getferdi/recipes/blob/master/docs/integration.md. \ No newline at end of file |
8 | |||
9 | 1. Copy your recipe files into `scripts/recipe_src` | ||
10 | 2. Open a terminal at `scripts/` | ||
11 | 3. Run `yarn install` to install all dependencies | ||
12 | 4. Run `yarn package` to package your new recipe | ||
13 | 5. Create a PR to <https://github.com/getferdi/recipes> with your new changes | ||
14 | |||
15 | ## Importing recipes from GitHub | ||
16 | If you've uploaded your recipe to GitHub, you can easily import it into the Ferdi recipe repository using the `add_github` script: | ||
17 | |||
18 | 1. Open a terminal at `scripts/` | ||
19 | 2. Run `yarn install` to install all dependencies | ||
20 | 3. Run `yarn github [GitHub URL]`, e.g. `yarn github https://github.com/vantezzen/franz-recipe-standardnotes`, to add your new recipe | ||
21 | 4. Create a PR to <https://github.com/getferdi/recipes> with your new changes \ No newline at end of file | ||