This commit is contained in:
parent
deeec7e87b
commit
5f0861cc6e
27
README.md
27
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
|
||||
## 🛠 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`.
|
Reference in New Issue
Block a user