From 2ea2a0f130aa697fc357ffd9640371aa1bfb936f Mon Sep 17 00:00:00 2001 From: Dave Gallant Date: Sat, 5 Nov 2022 22:53:04 -0400 Subject: [PATCH] Update README --- README.md | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 6054588..597c331 100644 --- a/README.md +++ b/README.md @@ -6,8 +6,18 @@ The frontend is made with Vue 3 and the backend is written in Go. The backend ex It is hosted at [rfd.fyi](https://rfd.fyi). +## Environment Variables + +Ensure that an `.env` file is filled in with the appropriate values. + +Example key/values can be found in [example.env](./example.env). + +*Note: that a [honeycomb](https://honeycomb.io/) API key is currently required.* + ## Local Development +If running locally, ensure that the ENV vars are exported to your shell. + To get up and running locally: in one pane/tab, run: ```sh @@ -20,12 +30,6 @@ In another pane/tab, run: make frontend ``` -## Honeycomb - -Ensure that an .env is filled in with appropriate values. - -See [example.env](./example.env). - ## Docker Compose ```sh