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 +```