Skip to content

Commit 6ec6e69

Browse files
Update 'Environment variables' section in README
1 parent 5b2005f commit 6ec6e69

File tree

1 file changed

+23
-3
lines changed

1 file changed

+23
-3
lines changed

README.md

Lines changed: 23 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,27 @@ Description of the app
3333
- To lint the repo: `make lint`
3434
- To run the app: `pipenv run my_app --help`
3535

36-
## Required ENV
36+
## Environment variables
37+
38+
### Required
39+
40+
```
41+
# If set to a valid Sentry DSN, enables Sentry exception monitoring. This is not needed for local development.
42+
SENTRY_DSN=
43+
44+
# Set to `dev` for local development, this will be set to `stage` and `prod` in those environments by Terraform.
45+
WORKSPACE=
46+
```
47+
48+
### Optional
49+
50+
_Delete this section if it isn't applicable to the PR._
51+
52+
```
53+
# Description for optional environment variable
54+
<OPTIONAL_ENV>=
55+
```
56+
57+
58+
3759

38-
- `SENTRY_DSN` = If set to a valid Sentry DSN, enables Sentry exception monitoring. This is not needed for local development.
39-
- `WORKSPACE` = Set to `dev` for local development, this will be set to `stage` and `prod` in those environments by Terraform.

0 commit comments

Comments
 (0)