From 8e184681ba99f4245447583d646c8ef885c02187 Mon Sep 17 00:00:00 2001
From: lukas-heilgenbrunner <lukas.heiligenbrunner@gmail.com>
Date: Wed, 29 May 2024 13:46:09 +0200
Subject: [PATCH] add readme

---
 README.md | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..9f91120
--- /dev/null
+++ b/README.md
@@ -0,0 +1,17 @@
+# Graph Databases Homework 3
+
+A simple route planning between cities with routes was implemented in Rust.
+
+## Run yourself
+The project has a minimum supported Rust version (MSRV) of 1.63.0.
+
+The Neo4j database has to be started on localhost on port 7687. 
+If you want a different port change it in `main.rs`
+
+To start the project run:
+
+`cargo run --package graphdbhue3 --bin graphdbhue3`
+
+## 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