From 03b91b18cf5b42923fd715849c93a1d11a195910 Mon Sep 17 00:00:00 2001
From: Nicolai Ort <info@nicolai-ort.com>
Date: Sat, 13 Feb 2021 21:58:39 +0100
Subject: [PATCH] Added readme for the repo

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..92f344b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,32 @@
+# @lfk/documentation
+
+The documentation for the LfK! 'Läufersystem'.
+Powered by Vuepress.
+
+## Quickstart 🐳
+> Use this to run the documentation server via docker.
+
+1. Clone the repo or copy the docker-compose.yml
+2. Cd into the folder containing the docker-compose.yml
+2. Run docker-compose: `docker-compose up -d`
+3. Visit http://127.0.0.1:8080/ to check if the server is running
+
+## Dev Setup 🛠
+> Local dev setup for previewing changes.
+
+1. Install Dependencies
+   ```bash
+   yarn
+   ```
+2. Start the server
+   ```bash
+   yarn dev
+   ```
+
+## Recommended Editor
+
+[Visual Studio Code](https://code.visualstudio.com/)
+
+### Recommended Extensions
+
+* will be automatically recommended via ./vscode/extensions.json
\ No newline at end of file