aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
blob: 24293289ab16bf6e1d6c56ef121b696a8cdbd8e4 (plain) (blame)
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
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
<p align="center">
    <a href="https://getferdi.com/services">
      <img src="./logo.svg" alt="" width="250"/>
    </a>
</p>

# Recipes

<p>
  <a href="https://github.com/getferdi/recipes/actions/workflows/builds.yml"><img alt="Build Status" src="https://github.com/getferdi/recipes/actions/workflows/builds.yml/badge.svg?branch=master&event=push"></a>
  <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
<a href='#contributors-'><img src='https://img.shields.io/badge/contributors-24-default.svg?logo=github' alt='Contributors'/></a>
<!-- ALL-CONTRIBUTORS-BADGE:END -->
  <a href="#backers-via-opencollective"><img alt="Open Collective backers" src="https://img.shields.io/opencollective/backers/getferdi?logo=open-collective"></a>
</p>

> 🍰 Recipes encapsulate your favourite apps into Ferdi for unified notifications handling and more

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.

## Creating and adding your own recipes

* [Overview / How to create a Ferdi integration](docs/integration.md)
* [How to update/change recipes](docs/updating.md)
* [Configuration (package.json)](docs/configuration.md)
* [Frontend API (webview.js)](docs/frontend_api.md)
* [Backend API (index.js)](docs/backend_api.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>
    <td align="center"><a href="https://github.com/deadmeu"><img src="https://avatars.githubusercontent.com/u/12111013?v=4?s=100" width="100px;" alt=""/><br /><sub><b>deadmeu</b></sub></a><br /><a href="https://github.com/getferdi/recipes/commits?author=deadmeu" title="Code">💻</a></td>
  </tr>
  <tr>
    <td align="center"><a href="https://github.com/ZwS"><img src="https://avatars.githubusercontent.com/u/2487205?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Anton Sudak</b></sub></a><br /><a href="https://github.com/getferdi/recipes/commits?author=ZwS" title="Code">💻</a></td>
    <td align="center"><a href="https://voidptr.de"><img src="https://avatars.githubusercontent.com/u/2692085?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Nils Steinger</b></sub></a><br /><a href="https://github.com/getferdi/recipes/commits?author=n-st" title="Code">💻</a></td>
    <td align="center"><a href="http://blog.simonszu.de"><img src="https://avatars.githubusercontent.com/u/700707?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Simon Szustkowski</b></sub></a><br /><a href="https://github.com/getferdi/recipes/commits?author=simonszu" title="Code">💻</a></td>
    <td align="center"><a href="https://github.com/jpmschuler"><img src="https://avatars.githubusercontent.com/u/12411176?v=4?s=100" width="100px;" alt=""/><br /><sub><b>jpmschuler</b></sub></a><br /><a href="https://github.com/getferdi/recipes/commits?author=jpmschuler" title="Code">💻</a></td>
    <td align="center"><a href="http://panz3r.dev"><img src="https://avatars.githubusercontent.com/u/1754457?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Mattia Panzeri</b></sub></a><br /><a href="https://github.com/getferdi/recipes/commits?author=panz3r" title="Code">💻</a></td>
    <td align="center"><a href="http://briankendall.net"><img src="https://avatars.githubusercontent.com/u/7917884?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Brian Kendall</b></sub></a><br /><a href="https://github.com/getferdi/recipes/commits?author=briankendall" title="Code">💻</a></td>
    <td align="center"><a href="http://maxmd.xyz"><img src="https://avatars.githubusercontent.com/u/25101871?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Maxime Marty-Dessus</b></sub></a><br /><a href="https://github.com/getferdi/recipes/commits?author=maximeMD" title="Code">💻</a></td>
  </tr>
  <tr>
    <td align="center"><a href="https://crtweb.ru/"><img src="https://avatars.githubusercontent.com/u/5560310?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Iaroslav</b></sub></a><br /><a href="https://github.com/getferdi/recipes/commits?author=RainGrid" title="Code">💻</a></td>
    <td align="center"><a href="https://github.com/TanZng"><img src="https://avatars.githubusercontent.com/u/25267490?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Tania R. Zúñiga</b></sub></a><br /><a href="https://github.com/getferdi/recipes/commits?author=TanZng" title="Code">💻</a></td>
    <td align="center"><a href="https://github.com/bpwned"><img src="https://avatars.githubusercontent.com/u/446744?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Alex</b></sub></a><br /><a href="https://github.com/getferdi/recipes/commits?author=bpwned" title="Code">💻</a></td>
    <td align="center"><a href="https://github.com/baukevdw"><img src="https://avatars.githubusercontent.com/u/6784391?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Bauke van der Woude</b></sub></a><br /><a href="https://github.com/getferdi/recipes/commits?author=baukevdw" title="Code">💻</a></td>
    <td align="center"><a href="https://github.com/pesader"><img src="https://avatars.githubusercontent.com/u/65264536?v=4?s=100" width="100px;" alt=""/><br /><sub><b>pesader</b></sub></a><br /><a href="https://github.com/getferdi/recipes/commits?author=pesader" title="Code">💻</a></td>
    <td align="center"><a href="https://github.com/tukiplus"><img src="https://avatars.githubusercontent.com/u/98679174?v=4?s=100" width="100px;" alt=""/><br /><sub><b>tukiplus</b></sub></a><br /><a href="https://github.com/getferdi/recipes/commits?author=tukiplus" title="Code">💻</a></td>
    <td align="center"><a href="https://www.linkedin.com/in/link2ravig/"><img src="https://avatars.githubusercontent.com/u/3313079?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Ravindra Gullapalli</b></sub></a><br /><a href="https://github.com/getferdi/recipes/commits?author=ravindragullapalli" title="Code">💻</a></td>
  </tr>
  <tr>
    <td align="center"><a href="https://github.com/brunoccr"><img src="https://avatars.githubusercontent.com/u/5890352?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Bruno Rossetto</b></sub></a><br /><a href="https://github.com/getferdi/recipes/commits?author=brunoccr" title="Code">💻</a></td>
    <td align="center"><a href="https://github.com/wajda"><img src="https://avatars.githubusercontent.com/u/795479?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Alex Vayda</b></sub></a><br /><a href="https://github.com/getferdi/recipes/commits?author=wajda" title="Code">💻</a></td>
    <td align="center"><a href="https://github.com/nurse-the-code"><img src="https://avatars.githubusercontent.com/u/68450431?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Malachi Gruenhagen</b></sub></a><br /><a href="https://github.com/getferdi/recipes/commits?author=nurse-the-code" 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!