diff --git a/README.md b/README.md index 53b37dd..019dc5e 100644 --- a/README.md +++ b/README.md @@ -72,16 +72,17 @@ You'll need to provide a Wallet Connect project id to enable onboarding and wall ## 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, app will fallback to public RPCs if not provided -- `VITE_PK_ENCRYPTION_KEY` (optional) AES encryption key used for signature obfuscation, need for enabling "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 bugsnap, used with `pnpm run build:inject-bugsnag` -- `IOS_APP_ID` (optional) IOS APP ID used for enabling deeplinking to the IOS APP, used with `pnpm run build:inject-app-deeplinks` -- `INTERCOM_APP_ID` (optional) used for enabling intercom, used with `pnpm run build:inject-intercom` -- `STATUS_PAGE_SCRIPT_URI` (optional) used for enabling status page, used with `pnpm run build:inject-statuspage` +- `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