From b8a112706867cbb08ebc5fde8a3877f440678741 Mon Sep 17 00:00:00 2001 From: Liliia Pelypenko Date: Fri, 21 May 2021 22:19:03 +0900 Subject: [PATCH] update README.md with new outputDirPath option --- README.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 266b63d..4e2f131 100644 --- a/README.md +++ b/README.md @@ -2,16 +2,19 @@ Creates an HTML report from axe-core library AxeResults object listing violations, passes, incomplete and incompatible results. -Allows specifying report creation options: `reportFileName`, `outputDir`, `projectKey` and `customSummary`. +Allows specifying report creation options: `reportFileName`, `outputDir`, `outputDirPath`, `projectKey` and `customSummary`. -`customSummary` allows having html parameters. +Notes: + +- `customSummary` allows having html parameters +- `outputDirPath` allows specifying absolute path Please check [sample report output.](https://lpelypenko.github.io/axe-html-reporter/) ## Install ``` -npm i axe-html-reporter +npm i -D axe-html-reporter ``` ## Usage