refactor: rewrite types, improve code quality

Aidbox · May 12, 2022 · 887db31 · 887db31
1 parent 55a007d
commit 887db31
Show file tree

Hide file tree

Showing 24 changed files with 2,080 additions and 4,492 deletions.
diff --git a/.github/workflows/test.yml → .github/workflows/chore.yml b/.github/workflows/test.yml → .github/workflows/chore.yml
@@ -1,4 +1,4 @@
-name: Test
+name: Build & Test
 
 on:
   push:

diff --git a/.nvmrc b/.nvmrc
@@ -0,0 +1 @@
+v16.15.0
diff --git a/README.md b/README.md
@@ -1 +1,21 @@
-![test](https://github.com/aidbox/node-server-sdk/actions/workflows/test.yml/badge.svg?branch=v2)
+![Build & Test](https://github.com/aidbox/node-server-sdk/actions/workflows/chore.yml/badge.svg?branch=v2)
+
+## Requirements
+
+- NodeJS 16 or above
+- Aidbox Instance (Local or Cloud)
+
+
+## Install
+
+```npm
+pnpm install @aidbox/node-server-sdk
+```
+or 
+```npm
+npm install @aidbox/node-server-sdk
+```
+or
+```npm
+yarn add @aidbox/node-server-sdk
+```