From f2b2f8bc74fc67805d733cbd039da824bd49eae0 Mon Sep 17 00:00:00 2001
From: Bennett
Date: Tue, 10 Mar 2020 16:06:45 +0100
Subject: Update README.md
---
README.md | 36 ++++++++++++++++++++++++------------
1 file changed, 24 insertions(+), 12 deletions(-)
diff --git a/README.md b/README.md
index 99afc94..b0424c2 100644
--- a/README.md
+++ b/README.md
@@ -3,16 +3,25 @@
# ferdi-server
-Unofficial Franz server replacement for use with the Ferdi Client.
-
-## Looking for a smaller alternative?
-[ferdi-slim-server](https://github.com/vantezzen/ferdi-slim-server) is a slim alternative to this project. Opposed to ferdi-server, ferdi-slim-server is only a wrapper around the Franz API that allows you to add custom recipes while still using the original Franz API.
-
-## Why use a custom ferdi-server?
-A custom ferdi-server allows you to experience the full potential of the Ferdi client. It allows you to use all Premium features (e.g. Workspaces and custom URL recipes) and [adding your own recipes](#creating-and-using-custom-recipes).
-
-## Demo
-You can find Ferdi's official API running this software at
+Official Server software for the [Ferdi Messaging Browser](https://getferdi.com)
+
+- [ferdi-server](#ferdi-server)
+ - [Why use a custom Ferdi server?](#why-use-a-custom-ferdi-server)
+ - [Features](#features)
+ - [Setup](#setup)
+ - [with Docker](#with-docker)
+ - [Manual setup](#manual-setup)
+ - [Configuration](#configuration)
+ - [Importing your Franz account](#importing-your-franz-account)
+ - [Transferring user data](#transferring-user-data)
+ - [Creating and using custom recipes](#creating-and-using-custom-recipes)
+ - [Listing custom recipes](#listing-custom-recipes)
+ - [License](#license)
+
+## Why use a custom Ferdi server?
+A custom server allows you to manage the data of all registered users yourself and add your own recipes to the repository.
+
+If you are not interested in doing this you can use our official instance of Ferdi server at .
## Features
- [x] User registration and login
@@ -20,13 +29,13 @@ You can find Ferdi's official API running this software at
+
## Creating and using custom recipes
ferdi-server allows to extends the Franz recipe catalogue with custom Ferdi recipes.
--
cgit v1.2.3-54-g00ecf