Skip to content

Commit 2470c81

Browse files
committed
Readme for Selenium
1 parent 4d4d08c commit 2470c81

3 files changed

Lines changed: 436 additions & 4 deletions

File tree

README.md

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
A powerful browser devtools extension for debugging, visualizing, and controlling test executions in real-time.
44

5-
Works with **WebdriverIO** and **[Nightwatch.js](./packages/nightwatch-devtools/README.md)** — same backend, same UI, same capture infrastructure.
5+
Works with **WebdriverIO**, **[Nightwatch.js](./packages/nightwatch-devtools/README.md)**, and **[Selenium WebDriver](./packages/selenium-devtools/README.md)** (any test runner) — same backend, same UI, same capture infrastructure.
66

77
## Features
88

@@ -94,7 +94,12 @@ npm install @wdio/devtools-service
9494
npm install @wdio/nightwatch-devtools
9595
```
9696

97-
> See the [Nightwatch Integration](#nightwatch-integration) section for configuration details.
97+
**Selenium WebDriver (any runner — Mocha / Jest / Cucumber / plain Node):**
98+
```bash
99+
npm install @wdio/selenium-devtools
100+
```
101+
102+
> See the [Nightwatch Integration](#nightwatch-integration) and [Selenium Integration](#selenium-integration) sections for configuration details.
98103
99104
## Configuration
100105

@@ -136,6 +141,12 @@ Using [Nightwatch.js](https://nightwatchjs.org/)? A dedicated adapter package br
136141

137142
**[`@wdio/nightwatch-devtools`](./packages/nightwatch-devtools/README.md)** — configuration, Cucumber/BDD setup, and limitations.
138143

144+
## Selenium Integration
145+
146+
Using `selenium-webdriver` directly — under Mocha, Jest, Cucumber, or a plain Node script? A runner-agnostic adapter brings the same DevTools UI to any Selenium test suite. The plugin auto-detects the runner and wires test boundaries; no code changes required for hook-aware runners, and a small `DevTools.startTest/endTest` API for plain scripts.
147+
148+
**[`@wdio/selenium-devtools`](./packages/selenium-devtools/README.md)** — per-runner setup, configuration options, and screencast details.
149+
139150
## Project Structure
140151

141152
```
@@ -144,7 +155,8 @@ packages/
144155
├── backend/ # Fastify server with test runner management
145156
├── service/ # WebdriverIO service and reporter
146157
├── script/ # Browser-injected trace collection script
147-
└── nightwatch-devtools/ # Nightwatch adapter plugin
158+
├── nightwatch-devtools/ # Nightwatch adapter plugin
159+
└── selenium-devtools/ # Selenium WebDriver adapter plugin (runner-agnostic)
148160
```
149161

150162
## Contributing

0 commit comments

Comments
 (0)