From ef2bc38a63d5ae63172105ae6cc452543ebb6f76 Mon Sep 17 00:00:00 2001 From: Nicolai Ort Date: Mon, 28 Apr 2025 20:26:32 +0200 Subject: [PATCH] docs: Update README with detailed setup and build instructions --- README.md | 20 +++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index fd305ca..5b76eec 100644 --- a/README.md +++ b/README.md @@ -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