diff options
| author |  vantezzen <hello@vantezzen.io> | 2020-05-10 10:41:55 +0200 |
|---|---|---|
| committer | vantezzen <hello@vantezzen.io> | 2020-05-10 10:41:55 +0200 |
| commit | d69e514dceb46a02cca4b73ea4fea487b93d71ad (patch) | |
| tree | 34bf182e0a28d784f3e7d321d41ef330b347d0e4 /docs | |
| parent | Update agent agent configuration (diff) | |
| download | ferdium-recipes-d69e514dceb46a02cca4b73ea4fea487b93d71ad.tar.gz ferdium-recipes-d69e514dceb46a02cca4b73ea4fea487b93d71ad.tar.zst ferdium-recipes-d69e514dceb46a02cca4b73ea4fea487b93d71ad.zip | |
Add create script
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/integration.md | 31 |
1 files changed, 22 insertions, 9 deletions
diff --git a/docs/integration.md b/docs/integration.md index 21d1399..d186704 100644 --- a/docs/integration.md +++ b/docs/integration.md | |||
| @@ -13,7 +13,8 @@ A Ferdi recipe is basically nothing else than a node module and is currently ini | |||
| 13 | ## Table of Contents | 13 | ## Table of Contents |
| 14 | - [Ferdi Recipe Documentation / Overview](#ferdi-recipe-documentation--overview) | 14 | - [Ferdi Recipe Documentation / Overview](#ferdi-recipe-documentation--overview) |
| 15 | - [Table of Contents](#table-of-contents) | 15 | - [Table of Contents](#table-of-contents) |
| 16 | - [Installation](#installation) | 16 | - [Preparing](#preparing) |
| 17 | - [Create a recipe](#create-a-recipe) | ||
| 17 | - [Recipe structure](#recipe-structure) | 18 | - [Recipe structure](#recipe-structure) |
| 18 | - [package.json](#packagejson) | 19 | - [package.json](#packagejson) |
| 19 | - [index.js](#indexjs) | 20 | - [index.js](#indexjs) |
| @@ -23,14 +24,26 @@ A Ferdi recipe is basically nothing else than a node module and is currently ini | |||
| 23 | - [Debugging](#debugging) | 24 | - [Debugging](#debugging) |
| 24 | - [Publishing](#publishing) | 25 | - [Publishing](#publishing) |
| 25 | 26 | ||
| 26 | ## Installation | 27 | ## Preparing |
| 27 | 1. To install a new recipe for testing, download the recipe folder e.g `whatsapp` or simply create an empty one with the name of your new recipe (we recommend using a recipe like `whatsapp` as a template though). | 28 | Before you can begin, you should have [NodeJS](http://nodejs.org/) installed and should be familiar with using npm, specifically "npm install" and "npm run". |
| 28 | 2. Open the development Ferdi Plugins folder on your machine (note that the `dev` directory may not exist yet, and you must create it): | 29 | |
| 29 | * Mac: `~/Library/Application Support/Ferdi/recipes/dev/` | 30 | You should also have basic knowledge of JavaScript - don't worry, you'll really only need some basic commands as we've already prepared the complicated stuff for you. |
| 30 | * Windows: `%appdata%/Ferdi/recipes/dev/` | 31 | |
| 31 | * Linux: `~/.config/Ferdi/recipes/dev` | 32 | ## Create a recipe |
| 32 | 3. Copy the recipe folder into this folder | 33 | 1. Clone this repository. You can do this by running `git clone https://github.com/getferdi/recipes.git` in your terminal or by downloading the repository from <https://github.com/getferdi/recipes/archive/master.zip>. |
| 33 | 4. Reload Ferdi (`CMD/CTRL + SHIFT + R`) | 34 | 2. Install its dependencies via the terminal: |
| 35 | ```Bash | ||
| 36 | cd scripts/ | ||
| 37 | npm install | ||
| 38 | ``` | ||
| 39 | 3. You can now run our automatic recipe wizard that creates and opens the new recipe for you: | ||
| 40 | ```Bash | ||
| 41 | # Make sure you are still in the scripts/ folder | ||
| 42 | npm run create "Service Name" | ||
| 43 | ``` | ||
| 44 | Replace `Service Name` with the name of your service, e.g. `npm run create "Google Hangouts"`. | ||
| 45 | This 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. | ||
| 46 | 4. Reload Ferdi (`CMD/CTRL + SHIFT + R`) in order for it to register the new recipe | ||
| 34 | 47 | ||
| 35 | ## Recipe structure | 48 | ## Recipe structure |
| 36 | Every recipe needs a specific file structure in order to work as a Ferdi recipe | 49 | Every recipe needs a specific file structure in order to work as a Ferdi recipe |