README.md


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49

<p align="center">
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
[![All Contributors](https://img.shields.io/badge/all_contributors-6-orange.svg?style=flat-square)](#contributors-)
<!-- ALL-CONTRIBUTORS-BADGE:END -->
    <a href="https://getferdi.com/services">
      <img src="./logo.svg" alt="" width="250"/>
    </a>
</p>

# Recipes

Official Recipe repository for Ferdi with over 100 recipes.

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.

## What are "Recipes"?

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.

Each time you create a new service inside Ferdi, Ferdi will automatically install and execute the recipe associated with that service.

## Creating and adding your own recipes

Please refer to our [documentation](docs/integration.md)

## Contributors ✨

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->
<table>
  <tr>
    <td align="center"><a href="https://github.com/bejonwe"><img src="https://avatars.githubusercontent.com/u/1766000?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Jonathan Weber</b></sub></a><br /><a href="https://github.com/getferdi/recipes/commits?author=bejonwe" title="Code">💻</a></td>
    <td align="center"><a href="https://gitlab.com/dpeukert"><img src="https://avatars.githubusercontent.com/u/3451904?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Daniel Peukert</b></sub></a><br /><a href="https://github.com/getferdi/recipes/commits?author=dpeukert" title="Code">💻</a></td>
    <td align="center"><a href="http://www.nathanaelhoun.fr"><img src="https://avatars.githubusercontent.com/u/45119518?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Nathanaël Houn</b></sub></a><br /><a href="https://github.com/getferdi/recipes/commits?author=nathanaelhoun" title="Code">💻</a></td>
    <td align="center"><a href="https://github.com/vbuzzano"><img src="https://avatars.githubusercontent.com/u/280143?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Vincent Buzzano</b></sub></a><br /><a href="https://github.com/getferdi/recipes/commits?author=vbuzzano" title="Code">💻</a></td>
    <td align="center"><a href="http://azkware.net"><img src="https://avatars.githubusercontent.com/u/1644021?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Carlos Solís</b></sub></a><br /><a href="https://github.com/getferdi/recipes/commits?author=csolisr" title="Code">💻</a></td>
    <td align="center"><a href="http://www.ruippeixotog.net"><img src="https://avatars.githubusercontent.com/u/613493?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Rui Gonçalves</b></sub></a><br /><a href="https://github.com/getferdi/recipes/commits?author=ruippeixotog" title="Code">💻</a></td>
  </tr>
</table>

<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->

<!-- ALL-CONTRIBUTORS-LIST:END -->

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!