From 258b68cbe8e12e8a8134044a156e0e190fd33441 Mon Sep 17 00:00:00 2001
From: ryluth <38672086+ryluth@users.noreply.github.com>
Date: Sat, 11 May 2019 01:05:14 +0200
Subject: [PATCH] Update README.md

---
 README.md | 25 ++++++++++++++++++++++++-
 1 file changed, 24 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index cc32b0e..8106abb 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,25 @@
 # docker-tmserver
-Docker image for simple or customizable Trackmania Nations/United Forever server
+Docker image for simple or customizable Trackmania Nations Forever server
+
+# How to use this image
+```docker run -e {required environment variables} -p {selected ports} fanyx/tmserver```
+
+There are several required environment variables that you need to set:
+  - `$SERVER_LOGIN`               | Server account login
+  - `$SERVER_LOGIN_PASSWORD`      | Server account password
+  - `$DB_HOST`                    | Hostname of the MySQL-Server
+  - `$DB_NAME`                    | Name of the MySQL-Database
+  - `$DB_LOGIN`                   | Name of the database user
+  - `$DB_LOGIN_PASSWORD`          | Password to the database user
+  - `$SERVER_PORT`                | Port for server communications
+  - `$SERVER_P2P_PORT`            | Port for peer2peer communications
+  
+Optional environment variables are:
+  - `$SERVER_SA_PASSWORD`         | Password for SuperAdmin credential
+  - `$SERVER_ADM_PASSWORD`        | Password for Admin credential
+  - `$SERVER_NAME`                | Server name in ingame browser
+  - `$SERVER_COMMENT`             | Server description
+
+# Running this image with `docker-compose`
+I have a default docker-compose.yml included in this repository.
+You can adjust this file to your needs but running with docker-compose is more comfortable in general.