aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorLibravatar vantezzen <hello@vantezzen.io>2020-03-08 11:10:17 +0100
committerLibravatar vantezzen <hello@vantezzen.io>2020-03-08 11:10:17 +0100
commit9d715597a600710c20f75412d3dcd8cdb7b3c39e (patch)
tree65ab812834d486aaccf35e2a31a7a628a7100422 /README.md
parentRevert to using the standart file comparison function (diff)
downloadferdi-recipes-9d715597a600710c20f75412d3dcd8cdb7b3c39e.tar.gz
ferdi-recipes-9d715597a600710c20f75412d3dcd8cdb7b3c39e.tar.zst
ferdi-recipes-9d715597a600710c20f75412d3dcd8cdb7b3c39e.zip
Add documentation
Diffstat (limited to 'README.md')
-rw-r--r--README.md18
1 files changed, 2 insertions, 16 deletions
diff --git a/README.md b/README.md
index 895663f..3bc7a84 100644
--- a/README.md
+++ b/README.md
@@ -3,19 +3,5 @@ Recipes for Ferdi.
3 3
4Copyright on these recipes is on their original creators. 4Copyright on these recipes is on their original creators.
5 5
6## Adding your own recipes 6## Creating and adding your own recipes
7After 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. 7Please refer to our documentation at https://github.com/getferdi/recipes/blob/master/docs/integration.md. \ No newline at end of file
8
91. Copy your recipe files into `scripts/recipe_src`
102. Open a terminal at `scripts/`
113. Run `yarn install` to install all dependencies
124. Run `yarn package` to package your new recipe
135. Create a PR to <https://github.com/getferdi/recipes> with your new changes
14
15## Importing recipes from GitHub
16If you've uploaded your recipe to GitHub, you can easily import it into the Ferdi recipe repository using the `add_github` script:
17
181. Open a terminal at `scripts/`
192. Run `yarn install` to install all dependencies
203. Run `yarn github [GitHub URL]`, e.g. `yarn github https://github.com/vantezzen/franz-recipe-standardnotes`, to add your new recipe
214. Create a PR to <https://github.com/getferdi/recipes> with your new changes \ No newline at end of file