aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorLibravatar Vijay A <vraravam@users.noreply.github.com>2021-11-24 14:56:57 +0530
committerLibravatar Vijay A <vraravam@users.noreply.github.com>2021-11-24 14:56:57 +0530
commitf0258d5be5f888d4039672c5a04e3bd9f4b9bb28 (patch)
treede32a4d556db568ca03fc4d73f732e8bb997815e
parentadd new 'xmpp' service recipe (diff)
downloadferdium-recipes-f0258d5be5f888d4039672c5a04e3bd9f4b9bb28.tar.gz
ferdium-recipes-f0258d5be5f888d4039672c5a04e3bd9f4b9bb28.tar.zst
ferdium-recipes-f0258d5be5f888d4039672c5a04e3bd9f4b9bb28.zip
docs: Update docs [skip ci]
-rw-r--r--docs/integration.md8
1 files changed, 7 insertions, 1 deletions
diff --git a/docs/integration.md b/docs/integration.md
index acbc6b5..c078ba1 100644
--- a/docs/integration.md
+++ b/docs/integration.md
@@ -41,7 +41,7 @@ We have also created a nice script that already does 50% of the work for you - y
41pnpm install 41pnpm install
42``` 42```
43 43
444. You can now run our automatic recipe wizard that creates and opens the new recipe for you: 444. (Optional - contd) You can now run our automatic recipe wizard that creates and opens the new recipe for you:
45 45
46```Bash 46```Bash
47# Make sure you are still in the repository's folder 47# Make sure you are still in the repository's folder
@@ -51,6 +51,12 @@ pnpm run create "Service Name"
51Replace `Service Name` with the name of your service, e.g. `pnpm run create "Google Hangouts"`. 51Replace `Service Name` with the name of your service, e.g. `pnpm run create "Google Hangouts"`.
52This command will automatically create the development recipe in the correct folder, prepares it for your service and opens the new recipe in your file explorer or Finder. 5. Reload Ferdi (`CMD/CTRL + SHIFT + R`) in order for it to register the new recipe 6. You can now develop your recipe as described below. Please continue down below with "[Publishing](#Publishing)" after you are done creating your recipe. 52This command will automatically create the development recipe in the correct folder, prepares it for your service and opens the new recipe in your file explorer or Finder. 5. Reload Ferdi (`CMD/CTRL + SHIFT + R`) in order for it to register the new recipe 6. You can now develop your recipe as described below. Please continue down below with "[Publishing](#Publishing)" after you are done creating your recipe.
53 53
545. (Mandatory) Please run the following step before raising a PR:
55```Bash
56pnpm run package
57```
58Fix any issues that are reported.
59
54## Recipe structure 60## Recipe structure
55 61
56Every recipe needs a specific file structure in order to work as a Ferdi recipe 62Every recipe needs a specific file structure in order to work as a Ferdi recipe