From 3f963ffb071db61151e482e82ca1f4c5a59f480c Mon Sep 17 00:00:00 2001
From: Bill <bill@dydx.exchange>
Date: Mon, 6 Nov 2023 10:50:45 -0800
Subject: [PATCH] Add Env var descriptions to readme (#124)

* Add Env var descriptions to readme

* update

* remove examples

* grammar
---
 .env.example | 10 +++++++---
 README.md    | 15 +++++++++++++++
 2 files changed, 22 insertions(+), 3 deletions(-)

diff --git a/.env.example b/.env.example
index 6071abb..cbfc529 100644
--- a/.env.example
+++ b/.env.example
@@ -4,7 +4,11 @@ VITE_ALCHEMY_API_KEY=
 
 VITE_PK_ENCRYPTION_KEY=
 
-VITE_WALLETCONNECT2_PROJECT_ID=
+VITE_V3_TOKEN_ADDRESS=
+VITE_TOKEN_MIGRATION_URI=
 
-VITE_V3_TOKEN_ADDRESS=0x6d5bb505a4f85c10b122ccc36e30f57e2b86a291
-VITE_TOKEN_MIGRATION_URI=https://bridge.dydx.trade/
\ No newline at end of file
+AMPLITUDE_API_KEY=
+BUGSNAG_API_KEY=
+IOS_APP_ID=
+INTERCOM_APP_ID=
+STATUS_PAGE_SCRIPT_URI=
diff --git a/README.md b/README.md
index 08ba6ef..019dc5e 100644
--- a/README.md
+++ b/README.md
@@ -69,6 +69,21 @@ You'll need to provide a Wallet Connect project id to enable onboarding and wall
 - Create a project on https://cloud.walletconnect.com/app
 - Copy over the project ID into this [field](https://github.com/dydxprotocol/v4-web/blob/67ecbd75b43e0c264b7b4d2d9b3d969830b0621c/public/configs/env.json#L822C33-L822C46)
 
+## Part 4: Set Enviornment variables
+Set environment variables via `.env`.
+
+- `VITE_BASE_URL` (required): The base URL of the deployment (e.g., `https://www.example.com`).
+- `VITE_ALCHEMY_API_KEY` (optional): Add an Alchemy API key for EVM interactions; the app will fall back to public RPCs if not provided.
+- `VITE_PK_ENCRYPTION_KEY` (optional): AES encryption key used for signature obfuscation; necessary for enabling the "Remember Me" feature.
+- `VITE_V3_TOKEN_ADDRESS` (optional): Address of the V3 $DYDX token.
+- `VITE_TOKEN_MIGRATION_URI` (optional): The URL of the token migration website.
+- `AMPLITUDE_API_KEY` (optional): Amplitude API key for enabling Amplitude; used with `pnpm run build:inject-amplitude`.
+- `BUGSNAG_API_KEY` (optional): API key for enabling Bugsnag; used with `pnpm run build:inject-bugsnag`.
+- `IOS_APP_ID` (optional): iOS app ID used for enabling deep linking to the iOS app; used with `pnpm run build:inject-app-deeplinks`.
+- `INTERCOM_APP_ID` (optional): Used for enabling Intercom; utilized with `pnpm run build:inject-intercom`.
+- `STATUS_PAGE_SCRIPT_URI` (optional): Used for enabling the status page; used with `pnpm run build:inject-statuspage`.
+
+
 # Deployments
 
 ## Deploying with Vercel