Merge pull request 'Updated README.md' (#14) from dev into main

2026-08-21 09:32:46 +02:00
parent afaa8fc4ee 976b275128
commit 82bbccd817
1 changed files with 33 additions and 0 deletions
@@ -1,2 +1,35 @@
 # dttmr-api

+An API backend for dittmar.dev, written in Go.
+
+## Getting started
+
+Building
+```shell
+make build
+```
+
+Running
+```shell
+make run
+```
+
+Run tests
+```
+make test
+```
+
+Run tests with coverage
+```
+make test-cover
+```
+
+Generate swagger documentation
+```shell
+make swag
+```
+
+Build docker image
+```shell
+make docker
+```