Merge pull request #31 from codenotary/publish-workflow

publish job and updated readme

Author: tomekkolo

.github/workflows/publish.yml

@@ -0,0 +1,33 @@
+name: Publish immudb node to npmjs
+on:
+  release:
+    types: [created]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    env:
+      NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+    steps:
+      - uses: actions/checkout@v3
+      # Setup .npmrc file to publish to npm
+      - uses: actions/setup-node@v3
+        with:
+          node-version: '16.x'
+          registry-url: 'https://registry.npmjs.org'
+      - name: Build
+        run: |
+          npm ci
+          npm run build
+      - name: Publish immudb-node-grpcjs
+        run: |
+          cd immudb-node-grpcjs
+          npm publish --access public --tag alpha
+      - name: Publish immudb-node-pbjs
+        run: |
+          cd immudb-node-pbjs
+          npm publish --access public --tag alpha
+      - name: Publish immudb-node
+        run: |
+          cd immudb-node
+          npm publish --access public --tag alpha
+

README.md

@@ -1,35 +1,37 @@
 # immudb-node [![License](https://img.shields.io/github/license/codenotary/immudb-node)](LICENSE)
 
-[![Slack](https://img.shields.io/badge/join%20slack-%23immutability-brightgreen.svg)](https://slack.vchain.us/) [![Discuss at [email protected]](https://img.shields.io/badge/discuss-immudb%40googlegroups.com-blue.svg)](https://groups.google.com/group/immudb)
+[![npm](https://img.shields.io/npm/v/@codenotary/immudb-node)](https://www.npmjs.com/package/@codenotary/immudb-node)
+[![Discord](https://img.shields.io/discord/831257098368319569)](https://discord.gg/EWeCbkjZVu) 
+[![Tweet about immudb!](https://img.shields.io/twitter/url/http/shields.io.svg?style=social&label=Tweet%20about%20immudb)](https://twitter.com/intent/tweet?text=immudb:%20lightweight,%20high-speed%20immutable%20database!&url=https://github.com/codenotary/immudb)
 
 ### Official [immudb] client for nodejs.
 
 [immudb]: https://immudb.io/
 
+# Old immudb client
 
-# Mono repository
+**[Old version of immudb node client](https://github.com/codenotary/immudb-node/releases/tag/v1.1.1)**
 
-
-If you don't plan developing this project, you will be only interested with:
-- [immudb-node](immudb-node) - ImmuDb client, or
-- [immudb-node-showcase](immudb-node-showcase) - ImmuDb client examples of usage.
+# immudb node client (Alpha) mono repository
 
 
 
-This repository contains following projects:
+If you don't plan developing this project, you will be only interested with:
 
-- [immudb-node](immudb-node) - ImmuDb client,
-- [immudb-node-showcase](immudb-node-showcase) - ImmuDb client examples of usage,
-- [immudb-node-doc](immudb-node-doc) - Documentation of ImmuDb client,
-- [immudb-node-grpcjs](immudb-node-grpcjs) - ImmuDb low lewel gprc bindings,
-- [immudb-node-pbjs](immudb-node-pbjs) - ImmuDb low lewel protobufers bindings,
-- [immudb-node-test](immudb-node-test) - ImmuDb client tests.
+- [immudb-node](immudb-node) - immudb client, or
+- [immudb-node-showcase](immudb-node-showcase) - immudb client examples of usage.
 
+This repository contains following projects:
 
+- [immudb-node](immudb-node) - immudb client, 
+- [immudb-node-showcase](immudb-node-showcase) - immudb client examples of usage, 
+- [immudb-node-doc](immudb-node-doc) - Documentation of immudb client,
+- [immudb-node-grpcjs](immudb-node-grpcjs) - immudb low lewel gprc bindings,
+- [immudb-node-pbjs](immudb-node-pbjs) - immudb low lewel protobufers bindings, 
+- [immudb-node-test](immudb-node-test) - immudb client tests.
 
 # Building project
 
-
 To (re)build all projects run in root directory:
 
 ```sh

immudb-node-doc/immudb-node/README.md

@@ -2,10 +2,14 @@ immudb-node / [Exports](modules.md)
 
 # Install & use
 
+To include (alpha) client in your code, do:
+
 ```sh
-npm install immudb-node
+npm install immudb-node@alpha
 ```
 
+Then use (see detailed examples in [showcases](../immudb-node-showcase/)):
+
 ```ts
 import { Client } from 'immudb-node'
 

immudb-node-doc/immudb-node/classes/common_errors.ImmudbClientError.md

@@ -52,7 +52,7 @@ Error.constructor
 
 #### Defined in
 
-[immudb-node/src/common/errors.ts:4](https://github.com/user3232/node-immu-db/blob/30c0d74/immudb-node/src/common/errors.ts#L4)
+[immudb-node/src/common/errors.ts:4](https://github.com/codenotary/immudb-node/blob/fe12060/immudb-node/src/common/errors.ts#L4)
 
 ## Properties
 

immudb-node-doc/immudb-node/classes/common_errors.InternalError.md

@@ -48,7 +48,7 @@
 
 #### Defined in
 
-[immudb-node/src/common/errors.ts:18](https://github.com/user3232/node-immu-db/blob/30c0d74/immudb-node/src/common/errors.ts#L18)
+[immudb-node/src/common/errors.ts:18](https://github.com/codenotary/immudb-node/blob/fe12060/immudb-node/src/common/errors.ts#L18)
 
 ## Properties
 
@@ -65,7 +65,7 @@
 
 #### Defined in
 
-[immudb-node/src/common/errors.ts:17](https://github.com/user3232/node-immu-db/blob/30c0d74/immudb-node/src/common/errors.ts#L17)
+[immudb-node/src/common/errors.ts:17](https://github.com/codenotary/immudb-node/blob/fe12060/immudb-node/src/common/errors.ts#L17)
 
 ___
 

immudb-node-doc/immudb-node/classes/common_errors.NoResponseValueError.md

@@ -48,7 +48,7 @@
 
 #### Defined in
 
-[immudb-node/src/common/errors.ts:26](https://github.com/user3232/node-immu-db/blob/30c0d74/immudb-node/src/common/errors.ts#L26)
+[immudb-node/src/common/errors.ts:26](https://github.com/codenotary/immudb-node/blob/fe12060/immudb-node/src/common/errors.ts#L26)
 
 ## Properties
 
@@ -58,7 +58,7 @@
 
 #### Defined in
 
-[immudb-node/src/common/errors.ts:25](https://github.com/user3232/node-immu-db/blob/30c0d74/immudb-node/src/common/errors.ts#L25)
+[immudb-node/src/common/errors.ts:25](https://github.com/codenotary/immudb-node/blob/fe12060/immudb-node/src/common/errors.ts#L25)
 
 ___
 

immudb-node-doc/immudb-node/classes/common_errors.OperationCanceledError.md

@@ -48,7 +48,7 @@
 
 #### Defined in
 
-[immudb-node/src/common/errors.ts:34](https://github.com/user3232/node-immu-db/blob/30c0d74/immudb-node/src/common/errors.ts#L34)
+[immudb-node/src/common/errors.ts:34](https://github.com/codenotary/immudb-node/blob/fe12060/immudb-node/src/common/errors.ts#L34)
 
 ## Properties
 
@@ -58,7 +58,7 @@
 
 #### Defined in
 
-[immudb-node/src/common/errors.ts:33](https://github.com/user3232/node-immu-db/blob/30c0d74/immudb-node/src/common/errors.ts#L33)
+[immudb-node/src/common/errors.ts:33](https://github.com/codenotary/immudb-node/blob/fe12060/immudb-node/src/common/errors.ts#L33)
 
 ___