diff --git a/accessibility-checker/README.md b/accessibility-checker/README.md index 414fa4048..5848bfb56 100644 --- a/accessibility-checker/README.md +++ b/accessibility-checker/README.md @@ -5,6 +5,15 @@ An automated accessibility testing for Node-based test environments from [IBM Eq To get started, please review [NPM](https://www.npmjs.com/package/accessibility-checker). +## Features + +- Scan single or multiple files, directories, or URLs +- Output scan report results in JSON, CSV, HTML or XSLX formats +- Set a target rule archive +- Configure policies to scan +- Set violation levels that trigger test failures +- Set violation levels that should be reported + ## Running Locally ### Install diff --git a/accessibility-checker/src/README.md b/accessibility-checker/src/README.md index 104a39f5a..ac7d2945c 100644 --- a/accessibility-checker/src/README.md +++ b/accessibility-checker/src/README.md @@ -150,7 +150,7 @@ module.exports = { ## Usage -### Command-line +### Command-line and multi-scan The module provides some basic command-line utilities that will allow you to scan files, directories, or URLs. You can also create a .txt file with path(s) to files, directories or a list of urls to be scanned, then provide the `npx achecker` the full path of the .txt file to start the scan (e.g. `npx achecker path/to/your/file.txt`). Run `npx achecker` for more information.