Skip to content

Commit 9c1d43b

Browse files
committed
docs: update README
1 parent 2d01246 commit 9c1d43b

File tree

1 file changed

+8
-5
lines changed

1 file changed

+8
-5
lines changed

README.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,8 @@ It’s designed to handle real-world scenarios where traditional drivers fall sh
1111

1212
> **Note**
1313
>
14-
> This driver is built for Appium 2 and is not compatible with Appium 1. To get started,
15-
> clone the repository and run `npm install` to resolve dependencies. Then, use `npm run build`
16-
> to build the driver. Finally, add it to your Appium 2 distribution with the command:
14+
> This driver is built for Appium 2/3 and is not compatible with Appium 1. To install
15+
> the driver, simply run:
1716
> `appium driver install --source=npm appium-novawindows-driver`
1817
1918

@@ -44,6 +43,11 @@ delayBeforeClick | Time in milliseconds before a click is performed.
4443
delayAfterClick | Time in milliseconds after a click is performed.
4544
appTopLevelWindow | The handle of an existing application top-level window to attach to. It can be a number or string (not necessarily hexadecimal). Example: `12345`, `0x12345`.
4645
shouldCloseApp | Whether to close the window of the application in test after the session finishes. Default is `true`.
46+
appArguments | Optional string of arguments to pass to the app on launch.
47+
appWorkingDir | Optional working directory path for the application.
48+
prerun | An object containing either `script` or `command` key. The value of each key must be a valid PowerShell script or command to be executed prior to the WinAppDriver session startup. See [Power Shell commands execution](#power-shell-commands-execution) for more details. Example: `{script: 'Get-Process outlook -ErrorAction SilentlyContinue'}`
49+
postrun | An object containing either `script` or `command` key. The value of each key must be a valid PowerShell script or command to be executed after WinAppDriver session is stopped. See [Power Shell commands execution](#power-shell-commands-execution) for more details.
50+
isolatedScriptExecution | Whether PowerShell scripts are executed in an isolated session. Default is `false`.
4751

4852
Please note that more capabilities will be added as the development of this driver progresses. Since it is still in its early stages, some features may be missing or subject to change. If you need a specific capability or encounter any issues, please feel free to open an issue.
4953

@@ -103,8 +107,7 @@ key to the listof enabled insecure features. Refer to [Appium Security document]
103107
It is possible to ether execute a single Power Shell command or a whole script
104108
and get its stdout in response. If the script execution returns non-zero exit code then an exception
105109
is going to be thrown. The exception message will contain the actual stderr. Unlike, Appium Windows Driver,
106-
there is no difference if you paste the script with `command` or `script` argument. For ease of use, you
107-
can even pass the script as a string only, it will work the same way.
110+
there is no difference if you paste the script with `command` or `script` argument. For ease of use, you can pass the script as a string when executing a PowerShell command directly via the driver. Note: This shorthand does not work when using the prerun or postrun capabilities, which require full object syntax.
108111
Here's an example code of how to control the Notepad process:
109112

110113
```java

0 commit comments

Comments
 (0)