From 90789dcd8744a3070d149c346d6a27d3d66ae499 Mon Sep 17 00:00:00 2001 From: Tim Nederhoff Date: Sun, 9 Dec 2018 17:34:00 +0100 Subject: [PATCH] fix: updated README.md for configuration --- .gitignore | 1 - README.md | 18 ++++++------------ 2 files changed, 6 insertions(+), 13 deletions(-) diff --git a/.gitignore b/.gitignore index fc7ed26..de8408f 100644 --- a/.gitignore +++ b/.gitignore @@ -1,6 +1,5 @@ lib node_modules -report.html !test/data/*.html .idea *.tgz diff --git a/README.md b/README.md index 2da2e83..08cee73 100644 --- a/README.md +++ b/README.md @@ -21,23 +21,17 @@ PICUS' HTML reporter generator for TestCafe automated tests. It provides an HTML $ npm install testcafe-reporter-html ``` -### 2. Configure +### 2. Add the reporter flag to your test task runner -If no configuration is specified, the generated file will be called `report.html` and found in the project's root path. -A configuration file `tcr-html.config.js` can be used to specify any value: - -```js -// tcr-html.config.js -module.exports = { - fileName: "test.html", - outputPath: "public", -}; +```sh +$ testcafe chrome test_folder/ --reporter html ``` -### 3. Add the reporter flag to your test task runner +### 3. Configure the output file +By default the html is written to `stdout`. To write the html to a file use the TestCafe build-in method: ```sh -$ testcafe chrome test_folder/ --reporter html +$ testcafe chrome test_folder/ --reporter html:path/to/my/file.html ``` ## Contributing