From 8ecd0f92dfd9c8b771b37d253af88d71dbb636de Mon Sep 17 00:00:00 2001
From: Eden Kirin <eden.kirin@intis.hr>
Date: Fri, 21 Apr 2023 15:19:35 +0200
Subject: [PATCH] Update readme

---
 Dockerfile |  6 +++---
 README.md  | 55 +++++++++++++++++++++++++++++++++++++++++++++++++++---
 2 files changed, 55 insertions(+), 6 deletions(-)

diff --git a/Dockerfile b/Dockerfile
index dbd7f58..fd27fd8 100644
--- a/Dockerfile
+++ b/Dockerfile
@@ -1,8 +1,8 @@
 FROM python:3.10.11-alpine3.17
 
-# take arguments
-ARG INTERNAL_API_PORT
-ARG INTERNAL_WS_PORT
+# handle optional arguments
+ARG INTERNAL_API_PORT=8010
+ARG INTERNAL_WS_PORT=8011
 
 RUN \
     pip install pip -U && \
diff --git a/README.md b/README.md
index ba0d4ff..9483aac 100644
--- a/README.md
+++ b/README.md
@@ -62,10 +62,59 @@ EndPlayer --> UnlockGame: Unlock game\n for all players
 
 ## FairHopper Game Server
 
+### Start server as docker container
+
+Build image:
+```sh
+docker build . -t CONTAINER_NAME
+```
+
+Create docker container:
+```sh
+docker \
+  create \
+  --publish EXTERNAL_API_PORT:8010 \
+  --publish EXTERNAL_WS_PORT:8011 \
+  --name=CONTAINER_NAME \
+  IMAGE_NAME
+```
+
+Parameters:
+- `EXTERNAL_API_PORT` - REST API port
+- `EXTERNAL_WS_PORT` - Websockets port
+- `CONTAINER_NAME` - FairHopper container name
+- `IMAGE_NAME` - FairHopper image name
+
+Start docker container:
+```sh
+docker start CONTAINER_NAME -d
+```
+
+Stop docker container:
+```sh
+docker stop CONTAINER_NAME
+```
+
+Example:
+```sh
+docker build . -t fairhopper-service
+docker \
+  run \
+  --publish 8010:8010 \
+  --publish 8011:8011 \
+  --name=fairhopper-service \
+  fairhopper \
+  --detach
+docker start fairhopper-service -d
+docker stop fairhopper-service
+```
+
+### Start server on local machine
+
 Requirements:
 - Python 3.10+
 
-### Install virtual envirnonment
+#### Install virtual envirnonment
 
 Project uses [Poetry](https://python-poetry.org), ultimate dependency management software for Python.
 
@@ -79,14 +128,14 @@ Install virtual environment:
 poetry install
 ```
 
-### Setting up
+#### Setting up
 
 Copy `settings_template.py` to `settings.py`.
 
 Edit `settings.py` and customize application.
 
 
-### Starting FairHopper Game Server
+#### Starting FairHopper Game Server
 
 ```sh
 make run