Просмотр исходного кода

Update crates documentation in a readme

develop
Predko Silvestr 3 лет назад
Родитель
Сommit
d2ec8d09ec
Аккаунт пользователя с таким Email не найден
1 измененных файлов: 16 добавлений и 1 удалений
  1. 16
    1
      README.md

+ 16
- 1
README.md Просмотреть файл

@@ -1,5 +1,20 @@
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 18
 ```mermaid
4 19
 sequenceDiagram
5 20
     participant Initiator

Загрузка…
Отмена
Сохранить