Skip to content

Commit

Permalink
Update docs with scanId and CLI info (#307)
Browse files Browse the repository at this point in the history
- Add information about the new scanId parameter available in the IScanner.Scan method
- Add a reference on the project readme to the newly minted CLI
  • Loading branch information
RobGallo authored Feb 12, 2020
1 parent 978c2cd commit 8bcdadd
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 1 deletion.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,11 @@ To get the latest version of the Axe.Windows NuGet package, visit

For more details and a complete code example, please visit the [automation reference page](./docs/AutomationReference.md)

## Command line interface

Axe.Windows also has a command line interface (CLI) to simplify automated testing in build pipelines. Please check out the
[command line interface readme](./src/CLI/readme.md)
for more information.

## Contributing

Expand Down
6 changes: 5 additions & 1 deletion docs/AutomationReference.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,11 @@ The Scan runs AxeWindows automated tests using the config provided at the time o

###### Parameters

The `Scan` method accepts no parameters.
The `Scan` method accepts 0 or 1 parameters.

**Name** | **Type** | **Description**
---|---|---
scanId | `string` | A string identifier for the scan. If the scan produces output files based on the `Config` object used to create the scanner, the output files will be given the name of the scan id (e.g., MyScanId.a11ytest).

###### Return object

Expand Down

0 comments on commit 8bcdadd

Please sign in to comment.