From aa24b1dce5d6d73c8f42fc57f81b692350bf9665 Mon Sep 17 00:00:00 2001
From: Philipp Dormann <philipp@philippdormann.de>
Date: Thu, 1 Apr 2021 19:32:10 +0200
Subject: [PATCH] =?UTF-8?q?=F0=9F=93=83=20added=20readme?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

ref #108
---
 README.md | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 00000000..92a8bcf9
--- /dev/null
+++ b/README.md
@@ -0,0 +1,22 @@
+# @odit/lfk-frontend
+
+## ✒️ Overview
+This is an API client for [https://git.odit.services/lfk/backend](@lfk/backend)
+- WebApp built with [Svelte](https://svelte.dev), [WindiCSS](https://windicss.org/) (to compile [TailwindCSS](https://tailwindcss.com/)) and [Vite](https://vitejs.dev).
+
+This application is intended for use by admin users/ members only.
+
+## 🚀 Getting Started
+```
+yarn
+```
+## Development
+```
+yarn dev
+/
+yarn dev --open
+```
+## Build
+```
+yarn build
+```
\ No newline at end of file