diff --git a/README.md b/README.md index 6553a40..e5f8b2b 100644 --- a/README.md +++ b/README.md @@ -26,3 +26,19 @@ All commands are run from the root of the project, from a terminal: | `pnpm run astro -- --help` | Get help using the Astro CLI | Documentation is available [here](https://docs.astro.build). + + +## Required Environment Variables + +This project requires certain environment variables to be present in order for builds to be successful. + +To solve this, create a file named `.env` and place the following inside: + + +``` +PUBLIC_VERCEL_GIT_REPO_OWNER=Xevion +PUBLIC_VERCEL_GIT_REPO_SLUG=undefined.behavio.rs +PUBLIC_VERCEL_GIT_COMMIT_SHA=ABC12345 +``` + +These variables will be provided by Vercel upon build, so the `.env` file is only useful in development mode. \ No newline at end of file