Version 0.0.1

Author: henripero

.github/workflows/npm-publish.yml

@@ -0,0 +1,23 @@
+# This workflow will run tests using node and then publish a package to GitHub Packages when a release is created
+# For more information see: https://docs.github.com/en/actions/publishing-packages/publishing-nodejs-packages
+
+name: Npm Publish Package
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  publish-npm:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 16
+          registry-url: https://registry.npmjs.org/
+      - run: npm ci
+      - run: npm run build
+      - run: npm publish --access public
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}

.gitignore

@@ -128,3 +128,6 @@ dist
 .yarn/build-state.yml
 .yarn/install-state.gz
 .pnp.*
+
+nodemon.json
+test.ts

README.md

@@ -1 +1,41 @@
-# lemonsoft-api-client
+# lemonsoft-api-client
+
+**LemonsoftApiClient** is a third party [Lemonsoft API](https://www.lemonsoft.fi/) client for NodeJS. It is a wrapper around an API client that has been [automatically generated](https://www.npmjs.com/package/swagger-typescript-api) using the [OpenAPI schema](https://rest-s01-prod02.lemonsoft.eu/Lemonsoft30/swagger/docs/v1) provided by Lemonsoft.
+
+## Installation
+
+Add to project's package.json:
+
+```
+npm install @rantalainen/lemonsoft-api-client
+```
+
+### Import to NodeJS project
+
+```javascript
+const { LemonsoftApiClient } = require('@rantalainen/lemonsoft-api-client');
+```
+
+### Import to TypeScript project
+
+```javascript
+import { LemonsoftApiClient } from '@rantalainen/lemonsoft-api-client';
+```
+
+## Setup client with options
+
+```javascript
+const lemonsoft = new LemonsoftApiClient(
+  {
+    userName: 'example@example.com',
+    password: 'password',
+    database: 'LemonDBx',
+    apiKey: 'api_key'
+  },
+  {
+    baseURL: 'https://rest-s01-prod02.lemonsoft.eu/Lemonsoft30'
+  }
+);
+```
+
+Available methods can be found in the [API documentation](https://rest-s01-prod02.lemonsoft.eu/Lemonsoft30/swagger/ui/index).