Updated env var docs (#294)

* Updated env var docs

Signed-off-by: Felipe Forbeck <felipe.forbeck@gmail.com>

* Update README.md

Co-authored-by: Jarrel deLottinville <jarrel.delottinville@gmail.com>

* added reviewer suggestions

Co-authored-by: Jarrel deLottinville <jarrel.delottinville@gmail.com>

.sample.env

@@ -0,0 +1,10 @@
+COUPON_CREATOR_ADDR=
+ETHERSCAN_API_KEY=
+TRUFFLE_MNEMONIC=
+INFURA_KEY=
+DEBUG_CONTRACT_VERIFICATION=true
+DAO_NAME=
+DAO_OWNER_ADDR=
+ERC20_TOKEN_SYMBOL=
+ERC20_TOKEN_NAME= 
+ERC20_TOKEN_DECIMALS=

README.md

@@ -100,26 +100,26 @@ You can find more information about the purpose of each access flag at [DAO Regi
 
 Added the following environment variables to your local .env file:
 
-```
-# The DAO Owner ETH Address (0x...) in the target network
-DAO_OWNER_ADDR=
-# The Infura API Key is used to communicate with the Ethereum blockchain
-INFURA_KEY=
-# The mnemonic that generates you account
-TRUFFLE_MNEMONIC=orange apple banana ...
-# Debug the Ether Scan contract verification calls
-DEBUG_CONTRACT_VERIFICATION=false
-# The Ether Scan API Key to verify the contracts after the deployment
-ETHERSCAN_API_KEY=
-# The public eth (0x...) address of the creator of the onboarding cupons
-COUPON_CREATOR_ADDR=
-# The ERC20 Token Name used by the ERC20 Token Extension
-ERC20_TOKEN_NAME=
-# The ERC20 Token Symbol used by the ERC20 Token Extension
-ERC20_TOKEN_SYMBOL=
-# The ERC20 Token Decimals to display in MetaMask
-ERC20_TOKEN_DECIMALS=
-```
+- `DAO_NAME`: The name of the DAO.
+- `DAO_OWNER_ADDR`: The DAO Owner ETH Address (0x...) in the target network.
+- `INFURA_KEY`: The Infura API Key is used to communicate with the Ethereum blockchain.
+- `TRUFFLE_MNEMONIC`: The truffle mnemonic string containing the 12 keywords.
+- `ETHERSCAN_API_KEY`: The Ether Scan API Key to verify the contracts after the deployment.
+- `DEBUG_CONTRACT_VERIFICATION`: Debug the Ether Scan contract verification calls (`true`|`false`).
+- `COUPON_CREATOR_ADDR`: The public eth (0x...) address of the creator of the onboarding coupons.
+- `ERC20_TOKEN_NAME`: The ERC20 Token Name used by the ERC20 Token Extension.
+- `ERC20_TOKEN_SYMBOL`: Token Symbol used by the ERC20 Token Extension.
+- `ERC20_TOKEN_DECIMALS`: The ERC20 Token Decimals to display in MetaMask.
+
+Checkout the [sample .env file](https://github.com/openlawteam/tribute-contracts/.sample.env).
+
+**Required env vars per deployment type**
+
+- Ganache deployment: `DAO_NAME`, `ERC20_TOKEN_NAME`, `ERC20_TOKEN_SYMBOL`, `ERC20_TOKEN_DECIMALS`, `COUPON_CREATOR_ADDR`.
+
+- Rinkeby deployment: `DAO_NAME`, `DAO_OWNER_ADDR`, `ERC20_TOKEN_NAME`, `ERC20_TOKEN_SYMBOL`, `ERC20_TOKEN_DECIMALS`, `COUPON_CREATOR_ADDR`.
+
+- Test deployment: `DAO_NAME`, `ERC20_TOKEN_NAME`, `ERC20_TOKEN_SYMBOL`, `ERC20_TOKEN_DECIMALS`.
 
 ### Run Tests