Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update feature list and highlight multi-scan in documentation #1230

Merged
merged 3 commits into from
Jan 20, 2023
Merged

Update feature list and highlight multi-scan in documentation #1230

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
efd95bd
Update feature list and highlight multi-scan in documentation
sct-will Jan 17, 2023
5d9f68f
Add XSLX to supported output report formats
sct-will Jan 17, 2023
0d1c58c
Merge branch 'master' into will-equal-access-955
ErickRenteria Jan 20, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions accessibility-checker/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion accessibility-checker/src/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down