Iterate on README [skip ci]

1 files changed, 33 insertions, 39 deletions

diff --git a/README.md b/README.md
index 9e91580..67167d9 100644
--- a/README.md
+++ b/README.md
@@ -2,7 +2,7 @@
     <img src="./logo.png" alt="" width="300"/>
 </p>
 
-# Ferdi-server
+# Server
 
 <p>
   <a href="https://github.com/getferdi/server/actions/workflows/builds.yml"><img alt="Build Status" src="https://github.com/getferdi/server/actions/workflows/builds.yml/badge.svg?branch=master&event=push"></a>
@@ -13,26 +13,18 @@
   <a href="https://gitter.im/getferdi/community"><img alt="Gitter Chat Room" src="https://img.shields.io/gitter/room/getferdi/community"></a>
 </p>
 
-Official Server software for the [Ferdi Messaging Browser](https://getferdi.com)
+> 👨🏾‍🍳 Server for [Ferdi](https://getferdi.com) that you can re-use to run your own
 
-- [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)
-  - [Contributing to Ferdi-server's development](#contributing-to-ferdi-servers-development)
-  - [License](#license)
+## Why use a custom server?
 
-## 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.
+_Find answers to other frequently asked questions on [getferdi.com/faq](https://getferdi.com/faq/)._
 
-If you are not interested in doing this you can use our official instance of Ferdi-server at <https://api.getferdi.com>.
+<details>
+<summary>Toggle answer</summary>
+
+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 the server at [api.getferdi.com](https://api.getferdi.com).
+
+</details>
 
 ## Features
 - [x] User registration and login
@@ -44,8 +36,8 @@ If you are not interested in doing this you can use our official instance of Fer
 - [ ] Password recovery
 - [ ] Recipe update
 
-## Setup
-### with Docker
+<details>
+<summary>Setup with Docker</summary>
 The easiest way to set up Ferdi-server on your server is with Docker.
 
 The Docker image can be run as is, with the default SQLite database or you can modify your ENV variables to use an external database (e.g. MySQL, MariaDB, Postgres, etc).
@@ -96,8 +88,9 @@ After setting up the docker container we recommend you set up an NGINX reverse p
 3. Optionally, you can [set up Nginx as a reverse proxy](https://www.digitalocean.com/community/tutorials/how-to-set-up-a-node-js-application-for-production-on-ubuntu-16-04#set-up-nginx-as-a-reverse-proxy-server).
 
 For more information on configuring the Docker image, please read [the Ferdi docker documentation](./docker/README.md).
-
-### Manual setup
+</details>
+<details>
+<summary>Manual setup</summary>
 
 1. Clone repository with submodule
 2. Install the [AdonisJS CLI](https://adonisjs.com/)
@@ -115,8 +108,9 @@ For more information on configuring the Docker image, please read [the Ferdi doc
     ```js
     npm start
     ```
-
-## Configuration
+</details>
+<details>
+<summary>Configuration</summary>
 
 franz-server's configuration is saved inside an `.env` file. Besides AdonisJS's settings, Ferdi-server has the following custom settings:
 - `IS_CREATION_ENABLED` (`true` or `false`, default: `true`): Whether to enable the [creation of custom recipes](#creating-and-using-custom-recipes)
@@ -125,19 +119,21 @@ franz-server's configuration is saved inside an `.env` file. Besides AdonisJS's
 - `CONNECT_WITH_FRANZ` (`true` or `false`, default: `true`): Whether to enable connections to the Franz server. By enabling this option, Ferdi-server can:
   - Show the full Franz recipe library instead of only custom recipes
   - Import Franz accounts
-
-## Importing your Franz account
+</details>
+<details>
+<summary>Importing your Franz account</summary>
 
 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.
-
-## Transferring user data
+</details>
+<details>
+<summary>Transferring user data</summary>
 
 Please refer to <https://github.com/getferdi/ferdi/wiki/Transferring-data-between-servers>
-
-## Creating and using custom recipes
-
+</details>
+<details>
+<summary>Creating and using custom recipes</summary>
 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).
@@ -149,18 +145,16 @@ To add your recipe to Ferdi-server, open `http://[YOUR FERDI-SERVER]/new` in you
 - `Service ID`: Unique ID for this recipe. Does not contain spaces or special characters (e.g. `google-drive`)
 - `Link to SVG image`: Direct link to a 1024x1024 SVG image 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.
-
-### Listing custom recipes
+</details>
+<details>
+<summary>Listing custom recipes</summary>
 
 Inside Ferdi, searching for `ferdi:custom` will list all of your custom recipes.
+</details>
 
-## Contributing to Ferdi-server's development
-
-We welcome all contributors. Please read the [contributing guidelines](CONTRIBUTING.md) to setup your development machine and proceed.
-
-## License
+## Contributing
 
-Ferdi-server is licensed under the MIT License
+Please read the [contributing guidelines](CONTRIBUTING.md) to setup your development machine and proceed.
 
 ## Contributors ✨