From fadf128fa5bb0012b7c9b879571e07e311642404 Mon Sep 17 00:00:00 2001
From: leonnicolas <leonloechner@gmx.de>
Date: Sun, 29 Nov 2020 16:37:31 +0100
Subject: [PATCH] README.md: update

---
 README.md | 21 +++++++++++++--------
 1 file changed, 13 insertions(+), 8 deletions(-)

diff --git a/README.md b/README.md
index 6a46ead..682dd5f 100644
--- a/README.md
+++ b/README.md
@@ -4,14 +4,16 @@ Apollo server written in typescript that handles business logic.
 [![Build Status](https://travis-ci.com/fLotte-meets-HWR-DB/apollo-server.svg?token=YfRmpHAXqyUafCgSEexw&branch=main)](https://travis-ci.com/fLotte-meets-HWR-DB/apollo-server)
 
 ## Assumptions
-Userserver and postgres are running e.g. with Julius' Docker Compose.
+The [flotte-user-management server](https://github.com/fLotte-meets-HWR-DB/flotte-user-management) and postgres are running. Set the [environment variables](#Environment-Variables) accordingly.
 ## Usage
 ### Docker
+You can build and run a docker image with
 ```bash
 docker build -t <image name> .
-docker run --rm -p 4000:4000 <image name>
+docker run --rm -p 4000:4000 <image name> -e ...
 ```
-### Compile and run
+Don't forget to pass all the [environment variables](#Environment-Variables) with the -e option.
+### Compile and Run
 Install gulp if not installed
 ```bash
 npm -g gulp
@@ -21,25 +23,28 @@ npm install
 gulp
 npm start
 ```
+You can set the [environment variables](#Environment-Variables) in a _.env_ file.
 ### For Development
 Install node\_modules and gulp
 ```bash
 npm -g gulp
 npm install
 ```
-And start gulp in watch mode
+Start gulp in watch mode to recompile the type script
 ```bash
-gulp watch
+gulp watchTs
 ```
-This will watch *.ts files in _./src_ and recompile to _./dist_ and finally restart the server.
+This will watch *.ts files in _./src_ and recompile to _./dist_. You will have to restart the server yourself.
 
 ## Environment Variables
 The following environment variables can be used to configure the server:
 ```bash
 RPC_HOST=host:port
-NODE_ENV=development/porduction
+NODE_ENV=develop/production
 POSTGRES_CONNECTION_URL=postgres://username:password@host:port/database_name
 ```
-- __RPC_HOST__ is used for the connection with the userserver.
+- __RPC_HOST__ is used for the connection with the [flotte-user-management server](https://github.com/fLotte-meets-HWR-DB/flotte-user-management).
 - __NODE_ENV__ will not check authentication if set to development
 - __POSTGRES_CONNECTION_URL__ for connection with the postgres database
+
+If the API server cannot connect to the [flotte-user-management server](https://github.com/fLotte-meets-HWR-DB/flotte-user-management) or the postgres data base. It will try to reconnect in an endless loop.