From 543379d7e4b3796985ad1582d7bf136ec7bd6b54 Mon Sep 17 00:00:00 2001 From: Nicolai Ort Date: Tue, 22 Dec 2020 15:22:57 +0100 Subject: [PATCH] Changes for the node/js split --- .drone.yml | 2 +- README.md | 8 ++++---- package.json | 8 ++++---- 3 files changed, 9 insertions(+), 9 deletions(-) diff --git a/.drone.yml b/.drone.yml index af4ba0f..976acb0 100644 --- a/.drone.yml +++ b/.drone.yml @@ -8,7 +8,7 @@ steps: commands: - git clone https://git.odit.services/lfk/backend backend - cd backend - - git checkout feature/31-lib_generation + - git checkout dev - name: run openapi export image: node:alpine commands: diff --git a/README.md b/README.md index 36e91de..5afe862 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# ODIT.Services - LfK-Client +# ODIT.Services - LfK-Client (Node Version) 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) @@ -9,7 +9,7 @@ Get's automagiclyâ„¢ build by drone for every new backend release. Basic example: Get all tracks ```typescript -import {OpenAPI, TrackService} from "@odit/lfk-client"; +import {OpenAPI, TrackService} from "@odit/lfk-client-node"; OpenAPI.BASE = "https://localhost:4010"; console.log(await TrackService.trackControllerGetAll()); ``` @@ -18,9 +18,9 @@ console.log(await TrackService.trackControllerGetAll()); Via yarn/npm: ```bash -yarn add @odit/lfk-client +yarn add @odit/lfk-client-node # Or -npm i @odit/lfk-client +npm i @odit/lfk-client-node ``` 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 diff --git a/package.json b/package.json index 0f99013..8cd71c5 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { - "name": "@odit/lfk-client", - "description": "A lib to interact with https://git.odit.services/lfk/backend", + "name": "@odit/lfk-client-node", + "description": "A lib to interact with https://git.odit.services/lfk/backend. Use this version for NodeJS applications.", "version": "0.0.3", "license": "CC-BY-NC-SA-4.0", "main": "./dist/index.js", @@ -27,9 +27,9 @@ "build:cleanup": "rimraf ./lib" }, "bugs": { - "url": "https://git.odit.services/lfk/lib/issues" + "url": "https://git.odit.services/lfk/lfk-client-node/issues" }, - "homepage": "https://git.odit.services/lfk/lib/", + "homepage": "https://git.odit.services/lfk/lfk-client-node/", "devDependencies": { "@types/node": "^14.14.13", "@types/node-fetch": "^2.5.7",