Extend README

1 files changed, 24 insertions, 4 deletions

diff --git a/README.md b/README.md
index e6110f6..74e1e22 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,6 @@
 # ferdi-server
 Unofficial Franz server replacement for use with the Ferdi Client.
 
-⚠️ Currently not to be used publicly/productively as there are no validations etc. yet.
-
 ## Features
 - [x] User registration and login
 - [x] Service creation, download, listing and removing
@@ -12,14 +10,36 @@ Unofficial Franz server replacement for use with the Ferdi Client.
 ## Setup
 1. Clone this repository
 2. Install the [AdonisJS CLI](https://adonisjs.com/)
-3. Run the database migrations with
+3. Copy `.env.example` to `.env` and edit the [configuration](#configuration) to your needs
+4. Run the database migrations with
     ```js
     adonis migration:run
     ```
-4. Start the server with
+5. Start the server with
     ```js
     adonis serve --dev
     ```
 
+## Configuration
+franz-server's configuration is saved inside the `.env` file. Besides AdonisJS's settings, ferdi-server has the following custom settings:
+- `IS_CREATION_ENABLED` (`true` or `false`): Whether to enable the [creation of custom recipes](#creating-and-using-custom-recipes)
+
+## Importing your Franz account
+ferdi-server allows you to import your full Franz account, including all its settings.
+
+To import your Franz account, open `http://[YOUR FERDI-SERVER]/import` in your browser and login using your Franz account details. ferdi-server will create a new user with the same credentials and copy your Franz settings, services and workspaces.
+
+## Creating and using custom recipes
+ferdi-server allows to extends the Franz recipe catalogue with custom Ferdi recipes.
+
+For documentation on how to create a recipe, please visit [the official guide by Franz](https://github.com/meetfranz/plugins/blob/master/docs/integration.md).
+
+To add your recipe to ferdi-server, open `http://[YOUR FERDI-SERVER]/new` in your browser. You can now define the following settings:
+- `Author`: Author who created the recipe
+- `Name`: Name for your new service. Can contain spaces and unicode characters
+- `Service ID`: Unique ID for this recipe. Does not contain spaces or special characters (e.g. `google-drive`)
+- `Link to PNG/SVG image`: Direct link to a 1024x1024 PNG image and SVG that is used as a logo inside the store. Please use jsDelivr when using a file uploaded to GitHub as raw.githubusercontent files won't load
+- `Recipe files`: Recipe files that you created using the [Franz recipe creation guide](https://github.com/meetfranz/plugins/blob/master/docs/integration.md). Please do *not* package your files beforehand - upload the raw files (you can drag and drop multiple files). ferdi-server will automatically package and store the recipe in the right format. Please also do not drag and drop or select the whole folder, select the individual files.
+
 ## License
 ferdi-server is licensed under the MIT License