From 8bcdadd00ae091587e17e99fcb3a0f7ec21266b0 Mon Sep 17 00:00:00 2001 From: RobGallo <43080011+RobGallo@users.noreply.github.com> Date: Wed, 12 Feb 2020 09:47:48 -0500 Subject: [PATCH] Update docs with scanId and CLI info (#307) - 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 --- README.md | 5 +++++ docs/AutomationReference.md | 6 +++++- 2 files changed, 10 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 617bb9cb3..c9396068c 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/docs/AutomationReference.md b/docs/AutomationReference.md index 3037ec182..4287c5099 100644 --- a/docs/AutomationReference.md +++ b/docs/AutomationReference.md @@ -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