Merge pull request #79 from shazow/env-example

README, .env.example: Add env example
shazow · Jan 15, 2024 · e95f8f5 · e95f8f5
2 parents a43a61c + 204d3bd
commit e95f8f5
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 1 deletion.
diff --git a/.env.example b/.env.example
@@ -0,0 +1,4 @@
+# Save as .env, fill in keys, gets automatically sourced by `nix develop`
+export INFURA_API_KEY="..."
+export ETHERSCAN_API_KEY="..."
+export PROVIDER="ethers"  # or "viem"
diff --git a/README.md b/README.md
@@ -172,7 +172,7 @@ console.log("Resolved to:", address);
 ## Development
 
 ```console
-$ cat .env
+$ cat .env  # Write an .env file with your keys, or `cp .env.example .env`
 export INFURA_API_KEY="..."
 export ETHERSCAN_API_KEY="..."
 $ nix develop  # Or use your system's package manager to install node/ts/etc