From 90b2d89a81510fd12a74e5969a1df6f9a67b7806 Mon Sep 17 00:00:00 2001 From: lukas-heilgenbrunner Date: Wed, 29 May 2024 13:49:02 +0200 Subject: [PATCH] aadd usage sec --- README.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index d2aee33..827cfce 100644 --- a/README.md +++ b/README.md @@ -15,4 +15,15 @@ To start the project run: ## Accessing Web Interface The API is exposed on Port `8081`. -Access it through the Swagger Web UI: [http://localhost:8081](http://localhost:8081) \ No newline at end of file +Access it through the Swagger Web UI: [http://localhost:8081](http://localhost:8081) + +## Usage + +### Adding cities and routes + +With the `/addcity` and `/addroute` endpoints you can add cities and link them together through routes. + +### Requesting shortest path + +Afterwards you can plan a route from one city to another with `/shortestpath`. +This returns the shortest path between the two cities respecting the `distance` parameter of the ROAD edge. \ No newline at end of file