aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorLibravatar vantezzen <hello@vantezzen.io>2020-03-23 20:53:08 +0100
committerLibravatar vantezzen <hello@vantezzen.io>2020-03-23 20:53:08 +0100
commit4bd9247f4b3efc92808552a851be10ad6546cc94 (patch)
tree505639a2953f9aaf7daf8109d0ddea002b6a25a7 /README.md
parentMove archives into seperate sub-folder (diff)
downloadferdium-recipes-4bd9247f4b3efc92808552a851be10ad6546cc94.tar.gz
ferdium-recipes-4bd9247f4b3efc92808552a851be10ad6546cc94.tar.zst
ferdium-recipes-4bd9247f4b3efc92808552a851be10ad6546cc94.zip
Improve README
Diffstat (limited to 'README.md')
-rw-r--r--README.md21
1 files changed, 17 insertions, 4 deletions
diff --git a/README.md b/README.md
index 3bc7a84..949d70d 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,20 @@
1# recipes 1<p align="center">
2Recipes for Ferdi. 2 <a href="https://getferdi.com/services">
3 <img src="./logo.svg" alt="" width="250"/>
4 </a>
5</p>
3 6
4Copyright on these recipes is on their original creators. 7# Recipes
8
9Official Recipe repository for Ferdi with over 100 recipes.
10
11Copyright on these recipes is on their original creators - please look at `uncompressed/<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
13## What are "Recipes"?
14Recipes 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
16Each time you create a new service inside Ferdi, Ferdi will automatically install and execute the recipe associated with that service.
5 17
6## Creating and adding your own recipes 18## Creating and adding your own recipes
7Please refer to our documentation at https://github.com/getferdi/recipes/blob/master/docs/integration.md. \ No newline at end of file 19Please refer to our documentation at https://github.com/getferdi/recipes/blob/master/docs/integration.md.
20