Basic readme

README.md

@@ -0,0 +1,21 @@
+# GLVD API
+
+This repo implements the HTTP API for GLVD.
+
+> [!NOTE]  
+> This is heavily work in progress.
+
+## Local Setup
+
+Required/recommended software:
+- [SAPMachine JDK 21](https://sap.github.io/SapMachine/)
+- [Podman Desktop/Machine](https://podman.io)
+- [Podman Compose](https://github.com/containers/podman-compose)
+
+A local setup including the database with sample data can be setup using podman compose.
+
+This requires building the jar file first.
+
+See `compose-up.sh` for the required steps to bring up a local environment.
+
+After about a minute you should be able to perform an HTTP GET request on http://localhost:8080/readiness and get a response with status code 200.