update readme

pinax-network · Feb 27, 2025 · 82145ae · 82145ae
1 parent 65346b7
commit 82145ae
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 2 deletions.
diff --git a/.gitignore b/.gitignore
@@ -4,4 +4,5 @@ replay.log
 /.idea
 out/
 state.yaml
-buf.gen.yaml
+buf.gen.yaml
+.DS_Store
diff --git a/README.md b/README.md
@@ -11,8 +11,20 @@ Includes the following:
 - [x] Clickhouse SQL
 - [ ] Subgraphs (SpS)
 
-## Modules included
+## Substreams Packages
 
 - [x] ERC-20 Balances & Transfers
 - [ ] ERC-20 Contract Metadata
 - [ ] ERC-20 Supply
+
+## Substreams Graph
+
+```mermaid
+graph TD;
+  graph_out[map: graph_out];
+  erc20_balances:map_events --> graph_out;
+  erc20_balances:map_events --> db_out;
+  erc20_balances:map_events[map: erc20_balances:map_events];
+  sf.substreams.v1.Clock[source: sf.substreams.v1.Clock] --> erc20_balances:map_events;
+  sf.ethereum.type.v2.Block[source: sf.ethereum.type.v2.Block] --> erc20_balances:map_events;
+```