aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorLibravatar vantezzen <hello@vantezzen.io>2020-01-14 20:50:29 +0100
committerLibravatar vantezzen <hello@vantezzen.io>2020-01-14 20:50:29 +0100
commit4561ff764e0ff16e80f1702a4291abd55fbd5ffa (patch)
tree0df1f6e961d2d146cd6e6fdf1273b9e909b2e4df /README.md
parentAdd habitica and mastodon (diff)
downloadferdium-recipes-4561ff764e0ff16e80f1702a4291abd55fbd5ffa.tar.gz
ferdium-recipes-4561ff764e0ff16e80f1702a4291abd55fbd5ffa.tar.zst
ferdium-recipes-4561ff764e0ff16e80f1702a4291abd55fbd5ffa.zip
Add info on usage of the GitHub script
Diffstat (limited to 'README.md')
-rw-r--r--README.md10
1 files changed, 9 insertions, 1 deletions
diff --git a/README.md b/README.md
index cb8c713..895663f 100644
--- a/README.md
+++ b/README.md
@@ -10,4 +10,12 @@ After creating your own recipe using [Franz's guide](https://github.com/meetfran
102. Open a terminal at `scripts/` 102. Open a terminal at `scripts/`
113. Run `yarn install` to install all dependencies 113. Run `yarn install` to install all dependencies
124. Run `yarn package` to package your new recipe 124. Run `yarn package` to package your new recipe
135. Create a PR to <https://github.com/getferdi/recipes> with your new changes \ No newline at end of file 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