Add documentation for how to test a project that uses simple-env

AmericanAirlines / simple-env

An intuitive, strongly typed, and scalable way to retrieve environment variables.

https://www.npmjs.com/package/@americanairlines/simple-env

MIT License

11 stars 9 forks source link

Add documentation for how to test a project that uses simple-env #20

Closed SpencerKaiser closed 1 year ago

SpencerKaiser commented 3 years ago

Pre-requisites:

[x] Yes, I looked through both open and closed issues looking for what I needed

Feature Description

When a user incorporates simple-env within their project, tests can get complicated and might fail in CI pipelines. We should add some documentation to show users how to best test the project via jest.

SpencerKaiser commented 3 years ago

@johnkahn make sure to include documentation for how to use the __mocks__ directory