diff --git a/README.md b/README.md index 97f22570..7807cc09 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,12 @@ # node-elm-test -Runs elm-test suites from Node.js +Runs [elm-test](https://github.com/deadfoxygrandpa/Elm-Test) suites from Node.js + +Install it with `npm install -g elm-test`, then try this after downloading this repository: + +```bash +cd examples +elm-package install --yes +elm-test Test.elm +``` + +Also check out [`elm-check`](https://github.com/TheSeamau5/elm-check) for property-based testing via `elm-test`! \ No newline at end of file