From 5f0861cc6e1e1ffb6b07f1a1d951b007edc6b10f Mon Sep 17 00:00:00 2001
From: Nicolai Ort <info@nicolai-ort.com>
Date: Sun, 13 Dec 2020 09:40:46 +0100
Subject: [PATCH] Added readme

---
 README.md | 27 +++++++++++++++++++++++++--
 1 file changed, 25 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index c74026c..36e91de 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,26 @@
-# lib
+# ODIT.Services - LfK-Client
+The official library for the LfK [backend server](https://git.odit.services/lfk/backend).
+Automagicly™ generated by [openapi-typescript-codegen](https://www.npmjs.com/package/openapi-typescript-codegen)
 
-The autogenerated lib
\ No newline at end of file
+## 🛠 Building
+Get's automagicly™ build by drone for every new backend release.
+
+## Use
+
+Basic example: Get all tracks
+```typescript
+import {OpenAPI, TrackService} from "@odit/lfk-client";
+OpenAPI.BASE = "https://localhost:4010";
+console.log(await TrackService.trackControllerGetAll());
+```
+
+### Install
+
+Via yarn/npm:
+```bash
+yarn add @odit/lfk-client
+# Or
+npm i @odit/lfk-client
+```
+
+Or just copy the folder `dist` to your prefered lib folder and import everything you need from `dist/index.ts`.
\ No newline at end of file