docs: ✏️ Shared config docs in the README.md

windingtree · Aug 18, 2022 · 7911a7e · 7911a7e
1 parent 7d6e21f
commit 7911a7e
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -8,6 +8,17 @@ A library of common components for the Win.so project
 yarn add @windingtree/win-commons
 ```
 
+## Shared config
+
+```typescript
+import { config } from '@windingtree/win-commons';
+
+// config.defaultZone
+// config.allowedNetworks
+// config.getNetworkInfo // helper, returns a network by its chainId
+// config.getNetworksByMode // helper, returns networks by the mode (dev, stage, prod)
+```
+
 ## Multisig helpers
 
 ```typescript