Skip to content

Commit

Permalink
update README.md with new outputDirPath option
Browse files Browse the repository at this point in the history
  • Loading branch information
lpelypenko committed May 21, 2021
1 parent fffe75a commit b8a1127
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit b8a1127

Please sign in to comment.