Skip to content

Commit

Permalink
Update README for specifying the .env filename
Browse files Browse the repository at this point in the history
  • Loading branch information
zackmoy authored Mar 4, 2024
1 parent a93b892 commit 5ed9278
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ is required in the same folder as the `.env.example` file.
# yarn add @zentered/envsync
```

Two things are required to use `EnvSync`:
#### Two things are required to use `EnvSync`:

1. An `.env.example` file (use `envsync//[variable]` to indicate a variable that
should be fetched from Secrets Manager). The first variable should be
Expand All @@ -69,6 +69,11 @@ Two things are required to use `EnvSync`:
}
```

#### Optional: Specifying the `.env` file:

- If you have multiple `.env` files, you can provide the filename as an argument. The `.env` example file must end in `.example`
- Usage: `npx envsync .env.development.example` will create `.env.development`

## Contributing

See [CONTRIBUTING](CONTRIBUTING.md).
Expand Down

0 comments on commit 5ed9278

Please sign in to comment.