aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorLibravatar kytwb <kytwb@pm.me>2021-12-23 20:11:56 +0100
committerLibravatar kytwb <kytwb@pm.me>2021-12-23 20:11:56 +0100
commitfc41a6a9c58f9a5db431880c488dbe04162d9f61 (patch)
tree2be00f5072d113335d7150db02d31f95a4cb286c /README.md
parentAdd badgeTemplate (diff)
downloadferdium-recipes-fc41a6a9c58f9a5db431880c488dbe04162d9f61.tar.gz
ferdium-recipes-fc41a6a9c58f9a5db431880c488dbe04162d9f61.tar.zst
ferdium-recipes-fc41a6a9c58f9a5db431880c488dbe04162d9f61.zip
Iterate on README [skip ci]
Diffstat (limited to 'README.md')
-rw-r--r--README.md12
1 files changed, 3 insertions, 9 deletions
diff --git a/README.md b/README.md
index 8e94f0a..9577c24 100644
--- a/README.md
+++ b/README.md
@@ -15,19 +15,13 @@
15 <a href="https://gitter.im/getferdi/community"><img alt="Gitter Chat Room" src="https://img.shields.io/gitter/room/getferdi/community"></a> 15 <a href="https://gitter.im/getferdi/community"><img alt="Gitter Chat Room" src="https://img.shields.io/gitter/room/getferdi/community"></a>
16</p> 16</p>
17 17
18Official Recipe repository for Ferdi with over 100 recipes. 18> 🍰 Recipes encapsulate your favourite apps into Ferdi for unified notifications handling and more
19 19
20Copyright 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. 20Recipes 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.
21
22## What are "Recipes"?
23
24Recipes 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.
25
26Each time you create a new service inside Ferdi, Ferdi will automatically install and execute the recipe associated with that service.
27 21
28## Creating and adding your own recipes 22## Creating and adding your own recipes
29 23
30Please refer to our [documentation](docs/integration.md) 24Please refer to our [documentation](docs/integration.md).
31 25
32## Contributors ✨ 26## Contributors ✨
33 27