Skip to content

Commit

Permalink
docs: adding reference guide (#144)
Browse files Browse the repository at this point in the history
* docs: adding reference guide

adding a section to list helpful resource guides to get started with building with env-schema

* Update README.md

Co-authored-by: Frazer Smith <[email protected]>

---------

Co-authored-by: Frazer Smith <[email protected]>
  • Loading branch information
lirantal and Fdawgs authored Jul 31, 2023
1 parent 7e1995f commit 96535da
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions README.md
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 @@ -253,6 +255,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

0 comments on commit 96535da

Please sign in to comment.