From 976b275128e2b409cec3bb4fc57a0b4441582a55 Mon Sep 17 00:00:00 2001 From: Robin Dittmar Date: Fri, 21 Aug 2026 09:32:16 +0200 Subject: [PATCH] fix: updated readme --- README.md | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) diff --git a/README.md b/README.md index 969d75d..1b31069 100644 --- a/README.md +++ b/README.md @@ -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 +``` -- 2.54.0