From 4561ff764e0ff16e80f1702a4291abd55fbd5ffa Mon Sep 17 00:00:00 2001 From: vantezzen Date: Tue, 14 Jan 2020 20:50:29 +0100 Subject: Add info on usage of the GitHub script --- README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) (limited to 'README.md') 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 2. Open a terminal at `scripts/` 3. Run `yarn install` to install all dependencies 4. Run `yarn package` to package your new recipe -5. Create a PR to with your new changes \ No newline at end of file +5. Create a PR to with your new changes + +## Importing recipes from GitHub +If you've uploaded your recipe to GitHub, you can easily import it into the Ferdi recipe repository using the `add_github` script: + +1. Open a terminal at `scripts/` +2. Run `yarn install` to install all dependencies +3. Run `yarn github [GitHub URL]`, e.g. `yarn github https://github.com/vantezzen/franz-recipe-standardnotes`, to add your new recipe +4. Create a PR to with your new changes \ No newline at end of file -- cgit v1.2.3-54-g00ecf