From 9732b6a75a0cbd6525f7c9287a4edbcfad4d0aee Mon Sep 17 00:00:00 2001 From: timdeschryver <28659384+timdeschryver@users.noreply.github.com> Date: Mon, 23 Sep 2019 18:40:35 +0200 Subject: [PATCH] docs: add readme to run example tests --- src/app/examples/README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) create mode 100644 src/app/examples/README.md diff --git a/src/app/examples/README.md b/src/app/examples/README.md new file mode 100644 index 00000000..9edf09ab --- /dev/null +++ b/src/app/examples/README.md @@ -0,0 +1,11 @@ +# 🦔 Angular Testing Library Examples + +Follow these three steps to run the example tests: + +- clone or download the repository +- move into the repository and install the needed dependencies with `npm install` +- use the command `npm run test:app` from within the root of this repository to run the tests + +The tests in this repository are written with [Jest](https://jestjs.io/), but you can use the test runner of your choice. + +If you're looking for an example that is not in this repository, feel free to create an [issue](https://github.com/testing-library/angular-testing-library/issues/new).