Merge pull request #100 from Relayz-io/silvestr/put-web-client-in-registry

Add CD pipeline for web-client

.github/workflows/cd.yml

+name: CD
+
+on:
+  pull_request:
+    branches:
+      - develop
+    types:
+      - closed
+
+jobs:
+  build-and-push-package:
+    if: github.event.pull_request.merged == true
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: lts/*
+          registry-url: https://npm.pkg.github.com
+          scope: "@relayz-io"
+      - uses: actions-rs/toolchain@v1
+        with:
+          toolchain: stable
+          target: wasm32-unknown-unknown
+      - name: Install wasm-pack
+        run: curl https://rustwasm.github.io/wasm-pack/installer/init.sh -sSf | sh
+      - name: Build an npm package
+        run: wasm-pack build web-client --target bundler --scope relayz-io --out-dir ../pkg --release
+      - name: Publish an npm package
+        run: |
+          cd pkg
+
+          if npm publish; then
+            echo "Package published"
+          else
+            echo "Package not published"
+          fi
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.GITHUB_TOKEN}}

README.md

-[![CI](https://github.com/Relayz-io/client/actions/workflows/ci.yml/badge.svg?branch=develop)](https://github.com/Relayz-io/client/actions/workflows/ci.yml)
-
 # Client
 
+[![CI](https://github.com/Relayz-io/client/actions/workflows/ci.yml/badge.svg?branch=develop)](https://github.com/Relayz-io/client/actions/workflows/ci.yml)
+
 ## Common-API 🦆
-Library that is used among other repositories. Implements [```Borsh```](https://borsh.io/) implementation for structures and enums. Also contain Diffie-Hellman and Ed25519 **API**
 
-## Near-Client 🗿
-Client library for **Near RPC**
+Commonly used **API** among different dependencies. For example **key-exchange-server**
 
 ## Web-Client 🦘
-Client library for communication from browser and *Near blockchain*. It's a high-level API. User doesn't need to understand how blockchain works.
+
+Client library for communication from browser and *Near blockchain*. It's a high-level **API**. User doesn't need to understand how blockchain works.
+
+### Usage of web-client library:
+
+Please follow the [official instructions](https://docs.github.com/en/enterprise-server@3.4/packages/working-with-a-github-packages-registry/working-with-the-npm-registry#installing-a-package) to use the latest package.
 
 ### Build
+
 ```sh
 wasm-pack build web-client --target bundler --out-dir ../pkg
 ```
 Then:
 
 `docker-compose up`
-
-## Diagrams
-```mermaid
-sequenceDiagram
-    participant Initiator
-    participant Alice
-    participant Bob
-
-    Initiator->>Blockchain: create meeting with id
-    Initiator-->>Internet: share meeting Id
-    loop
-        Initiator->>Blockchain: wait for pub. key for Alice and Bob
-        activate Blockchain
-        Blockchain--)Initiator: receive pub key [Alice, Bob]
-        deactivate Blockchain
-    end
-    par
-        Bob->>Internet: get meeting id
-        activate Internet
-        Internet--)Bob: receive meeting id
-        deactivate Internet
-    and
-        Alice->>Internet: get meeting id
-        activate Internet
-        Internet--)Alice: receive meeting id
-        deactivate Internet
-    end
-    par
-        Bob->>Blockchain: put temp public key for Bob
-        activate Blockchain
-        Blockchain--)Bob: Initiator public key
-        deactivate Blockchain
-    and
-        Alice->>Blockchain: put temp public key for Alice
-        activate Blockchain
-        Blockchain--)Alice: Initiator public key
-        deactivate Blockchain
-    end
-    Initiator-->>RelayServer: Olm message(symetric key) by Bob pub key
-    RelayServer-->>Bob: Olm message(symetric key) by Bob pub key
-    Initiator-->>RelayServer: Olm message(symetric key) by Alice pub key
-    RelayServer-->>Alice: Olm message(symetric key) by Alice pub key
-```