From 7d571ad46bd609cdcaa09fb65cae4865cc91abb4 Mon Sep 17 00:00:00 2001
From: Nicolai Ort <info@nicolai-ort.com>
Date: Mon, 2 Dec 2024 17:16:17 +0100
Subject: [PATCH] docs: Basic readme

---
 README.md | 31 +++++++++++++++++++++++++++++++
 1 file changed, 31 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..73e1bd2
--- /dev/null
+++ b/README.md
@@ -0,0 +1,31 @@
+# ✒️ Document generation microservices
+
+## Features
+
+- 📝 HTML pdf templates
+- 📚 OpenAPI/Swagger documentation
+- ⚡ High-performance with go and gotenberg
+
+## 🚀 Quick Start
+
+```bash
+# Install dependencies
+go mod download
+
+# Generate the swagger docs
+swag init
+
+# Run the server
+air
+```
+
+## 📖 API Documentation
+
+Swagger UI is available at: `/swagger`
+
+## 🛠️ Development
+
+The project uses:
+
+- 🏃‍♂️ go as the language and build tool
+- 🌐 gofiber for the web framework