docs: document the env variables

logos-innovation-lab · Oct 10, 2023 · 80bbd5d · 80bbd5d
1 parent 8128c7d
commit 80bbd5d
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 2 deletions.
diff --git a/.env b/.env
@@ -1,2 +1,2 @@
-PUBLIC_BLOCKCHAIN='gnosis'
-PUBLIC_WAKU='production'
+PUBLIC_BLOCKCHAIN=gnosis
+PUBLIC_WAKU=production
diff --git a/README.md b/README.md
@@ -24,6 +24,27 @@ pnpm build
 
 You can preview the production build with `pnpm preview`.
 
+## Config
+
+Use env variables to specify:
+
+```bash
+# Which waku node to connect to
+# Options:
+#    local       single waku node running in docker
+#    production  waku nodes used for production deployment
+# Defaults to
+PUBLIC_WAKU='production'
+
+# Which blockchain to connect to
+# Options:
+#    local    local chain running in docker
+#    chiado   chiado testnet
+#    gnosis   gnosis mainnet
+# Defaults to
+PUBLIC_BLOCKCHAIN='gnosis'
+```
+
 ## CLI
 
 There is a built-in command line tool for making development easier.