More docs

CryptoPascal31 · Apr 7, 2023 · 17fff23 · 17fff23
1 parent 343309d
commit 17fff23
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -27,6 +27,8 @@ This project uses the following tools:
 
 ## Principle of operation
 
+### Modules
+
 The protocol is organized in several modules:
    - `cyKlone-mutipool-V0`  => main module, manages most stuffs
    - `poseidon-hash-v1` and `poseidon-constants-v1` => Compute the Poseidon Hash
@@ -36,9 +38,16 @@ There are 2 helpers modules:
    - `cyKlone-work-gas-station` => Gas station to pay gas for the `(work)` transactions.
    - `cyKlone-relay-v0` => Gas station and intermediate account to let users withdraw while paying gas anonymously.
 
+![image info](./doc/img/cyKlone_modules.png)
+
+
+### Deposits/Withdrawal flow
+
 ![image info](./doc/img/cyKlone_diagram.png)
 
 
+
+
 ## TODO
   - Create a web UI
   - Organize a safe setup for the ZK keys.
diff --git a/doc/img/cyKlone_modules.png b/doc/img/cyKlone_modules.png