chore: document environment variables

stfsy · Nov 4, 2024 · d4d9442 · d4d9442
1 parent 823f17b
commit d4d9442
Showing 1 changed file with 8 additions and 0 deletions.
diff --git 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.