From d4d94420d050f2f6d1837dc6816c0534384fcd48 Mon Sep 17 00:00:00 2001 From: Stefan Pfaffel Date: Mon, 4 Nov 2024 19:11:53 +0100 Subject: [PATCH] chore: document environment variables --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index d6d8738..0292ad4 100644 --- a/README.md +++ b/README.md @@ -94,6 +94,14 @@ func startServerNonBlocking() { } ``` +### Configuration +This module will read the following environment variables. + +#### Env Vars +- `API_KIT_ENV`: default=production +#### Standard Env Vars +- `PORT`: default=8080 + ### Middlewares By default, four cross-cutting middlewares are configured. These build the foundation for a secure API.