From 4bd9247f4b3efc92808552a851be10ad6546cc94 Mon Sep 17 00:00:00 2001 From: vantezzen Date: Mon, 23 Mar 2020 20:53:08 +0100 Subject: Improve README --- README.md | 21 +++++++++++++++++---- 1 file changed, 17 insertions(+), 4 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 3bc7a84..949d70d 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,20 @@ -# recipes -Recipes for Ferdi. +

+ + + +

-Copyright on these recipes is on their original creators. +# Recipes + +Official Recipe repository for Ferdi with over 100 recipes. + +Copyright on these recipes is on their original creators - please look at `uncompressed//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 at https://github.com/getferdi/recipes/blob/master/docs/integration.md. \ No newline at end of file +Please refer to our documentation at https://github.com/getferdi/recipes/blob/master/docs/integration.md. + -- cgit v1.2.3-54-g00ecf