Added readme
Some checks failed
continuous-integration/drone/push Build is failing

This commit is contained in:
Nicolai Ort 2020-12-13 09:40:46 +01:00
parent deeec7e87b
commit 5f0861cc6e

View File

@ -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
## 🛠 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`.