docs: Update README with detailed setup and build instructions

This commit is contained in:
Nicolai Ort 2025-04-28 20:26:32 +02:00
parent 26d518fb8e
commit ef2bc38a63
Signed by: niggl
GPG Key ID: 13AFA55AF62F269F

View File

@ -5,7 +5,25 @@ The official library for the LfK [backend server](https://git.odit.services/lfk/
Automagicly™ generated by [openapi-typescript-codegen](https://www.npmjs.com/package/openapi-typescript-codegen)
## 🛠 Building
Get's automagicly™ build by drone for every new backend release.
### Setup ⬇️
```bash
git clone https://git.odit.services/lfk/lfk-client-js.git
cd lfk-client-js
pnpm i
```
### Build 🔨
```bash
pnpm update:openapi # Update the openapi.json file
pnpm build # Build the project
pnpm release # Bump and release to npm
# Or just do it all in one command
pnpm update
```
## Use