aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorLibravatar vantezzen <hello@vantezzen.io>2020-04-16 09:59:36 +0200
committerLibravatar vantezzen <hello@vantezzen.io>2020-04-16 09:59:36 +0200
commite2c0ef8f9f128b0ae0d96f14cff0f64226aed6d5 (patch)
treefc2ae83bf79ac5e68ca7fa1f0b930ce51f0360d8 /docs
parentMerge branch 'master' of https://github.com/getferdi/recipes (diff)
downloadferdium-recipes-e2c0ef8f9f128b0ae0d96f14cff0f64226aed6d5.tar.gz
ferdium-recipes-e2c0ef8f9f128b0ae0d96f14cff0f64226aed6d5.tar.zst
ferdium-recipes-e2c0ef8f9f128b0ae0d96f14cff0f64226aed6d5.zip
Switch from yarn to npm
Diffstat (limited to 'docs')
-rw-r--r--docs/integration.md8
-rw-r--r--docs/updating.md8
2 files changed, 8 insertions, 8 deletions
diff --git a/docs/integration.md b/docs/integration.md
index 7342495..174ba02 100644
--- a/docs/integration.md
+++ b/docs/integration.md
@@ -144,8 +144,8 @@ To add your own recipe to the repository:
144- If you already uploaded the recipe to GitHub: 144- If you already uploaded the recipe to GitHub:
145 1. Fork https://github.com/getferdi/recipes and clone it to your computer 145 1. Fork https://github.com/getferdi/recipes and clone it to your computer
146 2. Open a terminal in the `scripts/` folder of that repository 146 2. Open a terminal in the `scripts/` folder of that repository
147 3. Run `yarn install` to install all dependencies 147 3. Run `npm install` to install all dependencies
148 4. Run `yarn github [GitHub URL]`, e.g. `yarn github https://github.com/vantezzen/franz-recipe-standardnotes`, to add your new recipe 148 4. Run `npm run github [GitHub URL]`, e.g. `npm run github https://github.com/vantezzen/franz-recipe-standardnotes`, to add your new recipe
149 5. Create a PR to <https://github.com/getferdi/recipes> with your new changes 149 5. Create a PR to <https://github.com/getferdi/recipes> with your new changes
150 150
151- If you don't have it uploaded it GitHub: 151- If you don't have it uploaded it GitHub:
@@ -153,6 +153,6 @@ To add your own recipe to the repository:
153 1. Fork https://github.com/getferdi/recipes and clone it to your computer 153 1. Fork https://github.com/getferdi/recipes and clone it to your computer
154 2. Copy your recipe files into `scripts/recipe_src` 154 2. Copy your recipe files into `scripts/recipe_src`
155 3. Open a terminal at `scripts/` 155 3. Open a terminal at `scripts/`
156 4. Run `yarn install` to install all dependencies 156 4. Run `npm install` to install all dependencies
157 5. Run `yarn package` to package your new recipe 157 5. Run `npm run package` to package your new recipe
158 6. Create a PR to <https://github.com/getferdi/recipes> with your new changes 158 6. Create a PR to <https://github.com/getferdi/recipes> with your new changes
diff --git a/docs/updating.md b/docs/updating.md
index a01c694..ac2e126 100644
--- a/docs/updating.md
+++ b/docs/updating.md
@@ -27,7 +27,7 @@ After changing the files in that folder, you can reload the service inside Ferdi
27 27
28- Fork https://github.com/getferdi/recipes and clone it to your computer 28- Fork https://github.com/getferdi/recipes and clone it to your computer
29- Open a terminal in the `scripts/` folder of that repository 29- Open a terminal in the `scripts/` folder of that repository
30- Run `yarn install` to install all dependencies 30- Run `npm install` to install all dependencies
31 31
32This will setup the repository so that you can work on updating it. 32This will setup the repository so that you can work on updating it.
33 33
@@ -35,9 +35,9 @@ This will setup the repository so that you can work on updating it.
35 35
36Again, please **do not** edit any of the files located inside the `uncompressed` folder! Before editing, you'll need to "load" the recipe you want to edit using 36Again, please **do not** edit any of the files located inside the `uncompressed` folder! Before editing, you'll need to "load" the recipe you want to edit using
37```JavaScript 37```JavaScript
38yarn load <recipe id> 38npm run load <recipe id>
39``` 39```
40(e.g. `yarn load gmail`) 40(e.g. `npm run load gmail`)
41 41
42Your recipe is now loaded into `scripts/recipe_src`. You can now make changes to the files **in that folder*. 42Your recipe is now loaded into `scripts/recipe_src`. You can now make changes to the files **in that folder*.
43 43
@@ -47,6 +47,6 @@ In order for Ferdi to update its recipe, you'll need to bump its version number.
47 47
48## 5. Re-packaging the recipe 48## 5. Re-packaging the recipe
49 49
50You can now run `yarn package` to repackage your updated files. Your changes will be automatically copied into the recipe source at `uncompressed` and compressed into `archives/<recipe id>.tar.gz` - no need to update anything manually! 50You can now run `npm run package` to repackage your updated files. Your changes will be automatically copied into the recipe source at `uncompressed` and compressed into `archives/<recipe id>.tar.gz` - no need to update anything manually!
51 51
52## 6. Commit your changes and create a PR to <https://github.com/getferdi/recipes> 52## 6. Commit your changes and create a PR to <https://github.com/getferdi/recipes>