Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
gmrchk committed Feb 2, 2022
1 parent 51edde5 commit b51e9b6
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,8 @@ The `prepareEnvironment` returns a bunch of helpers described further.
An important part to notice is the use of `cleanup` function returned by the `prepareEnvironment`.
Just like the fully independent environment is created per test, it is also fully cleaned up this way, including any memory leaks in your CLI itself which could prevent tests from running correctly or hanging.

Note that the file path listed should be relative the path the test is running from. This is usually the root path of the project.

## API
As mentioned before, `prepareEnvironment` is at the core of this library.
Any test begins with creating an independent environment.
Expand Down

0 comments on commit b51e9b6

Please sign in to comment.