Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: adding reference guide #144

Merged
merged 2 commits into from
Jul 31, 2023
Merged

docs: adding reference guide #144

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1c51f40
docs: adding reference guide
lirantal Dec 25, 2022
c729942
Update README.md
lirantal Dec 26, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@
Utility to check environment variables using [JSON schema](https://json-schema.org/), [Ajv](http://npm.im/ajv), and
[dotenv](http://npm.im/dotenv).

See [supporting resources](#supporting-resources) section for helpful guides on getting started.

## Install

```
Expand Down Expand Up @@ -245,6 +247,13 @@ export type EnvSchemaData = {
}
```

## Supporting resources

The following section lists helpful reference applications, articles, guides and other
resources that demonstrate the use of env-schema in different use-cases and scenarios:

* A reference application using [Fastify with env-schema and dotenv](https://github.com/lirantal/fastify-dotenv-envschema-example)

## Acknowledgements

Kindly sponsored by [Mia Platform](https://www.mia-platform.eu/) and
Expand Down