From e89c17806f2c12d1b7d3af9e29bb75f17e41f9c8 Mon Sep 17 00:00:00 2001
From: Nicolai Ort <info@nicolai-ort.com>
Date: Wed, 11 Dec 2024 19:29:04 +0100
Subject: [PATCH] docs: Updated readme

---
 README.md | 40 ++++++++++++++++++++++++++++++++++++----
 1 file changed, 36 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index 73e1bd2..47770b4 100644
--- a/README.md
+++ b/README.md
@@ -2,7 +2,7 @@
 
 ## Features
 
-- 📝 HTML pdf templates
+- 📝 HTML templates for pdf generation
 - 📚 OpenAPI/Swagger documentation
 - ⚡ High-performance with go and gotenberg
 
@@ -12,9 +12,6 @@
 # Install dependencies
 go mod download
 
-# Generate the swagger docs
-swag init
-
 # Run the server
 air
 ```
@@ -29,3 +26,38 @@ The project uses:
 
 - 🏃‍♂️ go as the language and build tool
 - 🌐 gofiber for the web framework
+- 📦 air for live reload
+- 📝 swaggo for API documentation
+- 📄 gotenberg for HTML to PDF conversion
+
+### 📦 Use docker compose for external dependencies
+
+```shell
+docker compose -f docker-compose.dev.yaml up
+```
+
+### 🏃 Run via air
+
+> Install air via `go install github.com/air-verse/air@latest`
+
+```shell
+air
+```
+
+### ✒️ Update the swagger docs
+
+> Install swag via `go install github.com/swaggo/swag/cmd/swag@latest`
+
+```shell
+swag init
+```
+
+### 🐋 Build container
+
+```shell
+# single arch
+docker build -t registry.odit.services/lfk/document-server:latest .
+
+# multiarch
+docker buildx build --platform=linux/amd64,linux/arm64 -t registry.odit.services/lfk/document-server:latest --push .
+```