From 264d6a376e9cf4e8df4216ef1bbdb34910fb042b Mon Sep 17 00:00:00 2001
From: gjahn <gregor.jahn@bht-berlin.de>
Date: Mon, 6 Nov 2023 23:35:49 +0100
Subject: [PATCH] Add readme

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..0a309b8
--- /dev/null
+++ b/README.md
@@ -0,0 +1,20 @@
+Webservice
+==========
+
+A Go-based simple web service meant to be the subject for any tutorial
+or even the project work.
+
+
+__Prerequisites:__
+
+* Go toolchain (install via system package manager or [by hand](https://go.dev/doc/install))
+
+
+__Main interactions:__
+
+1. Install dependencies: `go get -t ./...`
+2. Run locally: `go run .`
+3. Execute unit tests: `go test -race -v ./...`
+4. Build artifact: `go build -o ./artifact.bin ./*.go`
+
+For more details, please refer to the `Makefile`.
-- 
GitLab