瀏覽代碼

Merge pull request #42 from Relayz-io/silvestr/update-readme

Update crates documentation in a readme
develop
Predko Silvestr 2 年之前
父節點
當前提交
b873886108
沒有連結到貢獻者的電子郵件帳戶。
共有 1 個檔案被更改,包括 16 行新增1 行删除
  1. 16
    1
      README.md

+ 16
- 1
README.md 查看文件

1
-# client
1
+# Client
2
 
2
 
3
+## Common-API 🦆
4
+Library that is used among other repositories. Implements [```Borsh```](https://borsh.io/) implementation for structures and enums. Also contain Diffie-Hellman and Ed25519 **API**
5
+
6
+## Near-Client 🗿
7
+Client library for **Near RPC**
8
+
9
+## Web-Client 🦘
10
+Client library for communication from browser and *Near blockchain*. It's a high-level API. User doesn't need to understand how blockchain works.
11
+
12
+### Build
13
+```sh
14
+wasm-pack build web-client --target bundler --out-dir ../pkg
15
+```
16
+
17
+## Diagrams
3
 ```mermaid
18
 ```mermaid
4
 sequenceDiagram
19
 sequenceDiagram
5
     participant Initiator
20
     participant Initiator

Loading…
取消
儲存