From df94b1b750922989d870546150ff8d9ff8af4102 Mon Sep 17 00:00:00 2001
From: Nicolai Ort <info@nicolai-ort.com>
Date: Tue, 2 Feb 2021 14:35:10 +0100
Subject: [PATCH] Added a basic readme

ref #6
---
 README.md | 32 ++++++++++++++++++++++++++++++--
 1 file changed, 30 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 3e2c277..8663bdf 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,31 @@
-# document-server
+# @lfk/document-server
 
-The document generation server responsible for creating pdfs for sponsoring contracts, certificates and more.
\ No newline at end of file
+The document generation server responsible for creating pdfs for sponsoring contracts, certificates and more.
+
+## Quickstart 🐳
+> Use this to run the document server in docker.
+
+1. Clone the repo or copy the docker-compose 
+2. Run in toe folder that contains the docker-compose file: `docker-compose up -d`
+3. Visit http://127.0.0.1:4010/docs to check if the server is running
+
+## Dev Setup 🛠
+> Local dev setup
+
+1. Rename the .env.example file to .env (you can adjust app port and other settings, if needed)
+2. Install Dependencies
+   ```bash
+   yarn
+   ```
+3. Start the server
+   ```bash
+   yarn dev
+   ```
+
+## ENV Vars
+> You can provide them via .env file or docker env vars.
+
+| Name | Type | Default | Description
+| - | - | - | -
+| APP_PORT | Number | 4010 | The port the backend server listens on. Is optional.
+| NODE_ENV | String | dev | The apps env - influences debug info.
\ No newline at end of file