diff options
| author |  Vijay A <avijayr@protonmail.com> | 2021-05-15 18:45:22 +0530 |
|---|---|---|
| committer |  Vijay Raghavan Aravamudhan <vraravam@users.noreply.github.com> | 2021-05-15 19:33:09 +0530 |
| commit | 882504b4348c795b1fb5f5a6e61542f3cddad02a (patch) | |
| tree | bf6bed4cf9e6d807d009bba7be92a75e59563c7f /README.md | |
| parent | Housekeeping: These recipes had been updated for bug fixes since Apr 2020, bu... (diff) | |
| download | ferdium-recipes-882504b4348c795b1fb5f5a6e61542f3cddad02a.tar.gz ferdium-recipes-882504b4348c795b1fb5f5a6e61542f3cddad02a.tar.zst ferdium-recipes-882504b4348c795b1fb5f5a6e61542f3cddad02a.zip | |
Housekeeping: Fixed markdown rule violations.
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 7 |
1 files changed, 5 insertions, 2 deletions
| @@ -11,12 +11,15 @@ Official Recipe repository for Ferdi with over 100 recipes. | |||
| 11 | Copyright on these recipes is on their original creators - please look at `recipes/<id>/package.json` for information about the original creator and license. This is simply a curation of those recipes so we can include them into Ferdi. | 11 | Copyright on these recipes is on their original creators - please look at `recipes/<id>/package.json` for information about the original creator and license. This is simply a curation of those recipes so we can include them into Ferdi. |
| 12 | 12 | ||
| 13 | ## What are "Recipes"? | 13 | ## What are "Recipes"? |
| 14 | |||
| 14 | Recipes are small scripts that are responsible for providing the connection between your services (e.g. WhatsApp, GMail or Slack) and Ferdi. It provides Ferdi information like the number of current notifications, handles enabling dark mode and may otherwise improve your experience with the service. | 15 | Recipes are small scripts that are responsible for providing the connection between your services (e.g. WhatsApp, GMail or Slack) and Ferdi. It provides Ferdi information like the number of current notifications, handles enabling dark mode and may otherwise improve your experience with the service. |
| 15 | 16 | ||
| 16 | Each time you create a new service inside Ferdi, Ferdi will automatically install and execute the recipe associated with that service. | 17 | Each time you create a new service inside Ferdi, Ferdi will automatically install and execute the recipe associated with that service. |
| 17 | 18 | ||
| 18 | ## Creating and adding your own recipes | 19 | ## Creating and adding your own recipes |
| 19 | Please refer to our documentation at https://github.com/getferdi/recipes/blob/master/docs/integration.md. | 20 | |
| 21 | Please refer to our [documentation](docs/integration.md) | ||
| 20 | 22 | ||
| 21 | ## Minifying images | 23 | ## Minifying images |
| 22 | Please run `npm run minify-images` to optimize images | 24 | |
| 25 | Please run `npm run minify-images` to optimize images before you commit or raise PRs into this repository | ||