From 6319d10438cc9e8c1f83b22e1b307c08e8b2f6dc Mon Sep 17 00:00:00 2001
From: Benedikt Seeger <benedikt.seeger@ptb.de>
Date: Thu, 25 Apr 2024 16:22:01 +0200
Subject: [PATCH] updated readme

---
 readme.md | 15 +++++++++------
 1 file changed, 9 insertions(+), 6 deletions(-)

diff --git a/readme.md b/readme.md
index 842261b..523cf81 100644
--- a/readme.md
+++ b/readme.md
@@ -14,19 +14,22 @@ pip install -r requirements.txt
 bokeh serve ./ --port 5020
 ```
 ### Run the rest API
-
+```bash
+uvicorn restAPIServer:app --host 0.0.0.0 --port 5021
+```
 ## Use Docker Container
 
 ```bash
 docker pull benesee/dsiunitsfrontend:latest
-docker run -p 5020:5020 benesee/dsiunitsfrontend:latest
+docker run -p 5020:5020 -p 5021:5021 benesee/dsiunitsfrontend:latest
 ```
+Change target port by changing the first port number in the -p option to the desired port number
+urls of the services are:
+- [http://localhost:5020/dsi-parser-frontend/main](http://localhost:5020/dsi-parser-frontend/main) for the Bokeh GUI
+- [http://localhost:5020](http://localhost:5020) for the GUI
+- [http://localhost:5021/docs](http://localhost:5021/docs) for the rest API documentation
 
 
-Creating comprehensive API documentation for your FastAPI application helps users understand how to interact with your endpoints effectively. Below is a markdown format that you can use for your README file or any other documentation platform. This example includes descriptions of the endpoints, expected inputs, and outputs based on the FastAPI code you provided.
-
----
-
 # API Documentation for Unit Conversion Service
 
 This documentation covers the available REST API endpoints for converting unit strings to UTF-8 and LaTeX formats, as well as comparing different units for scalability and conversion. Each endpoint is described with its functionality, required input, and example responses.
-- 
GitLab