diff --git a/packages/service/README.md b/packages/service/README.md index 3a1fbd3..5e0cfe3 100644 --- a/packages/service/README.md +++ b/packages/service/README.md @@ -1,48 +1,32 @@ -# DevTools Hook -Hook your WebdriverIO project up with Devtools capabilities. +# @wdio/devtools-service -## Install +DevTools is a UI test runner for WebdriverIO. It provides a user interface for running, debugging, and inspecting your browser automation tests, along with advanced features like network interception, performance tracing, and more. -You can install the package via: +## Installation + +Install the service in your project: ```sh -npm install @devtools/hook +npm install @wdio/devtools-service --save-dev ``` -## Usage - -You can collect WebdriverIO trace data within standalone or testrunner environments. Read more on these different modes in the [docs](https://webdriver.io/docs/setuptypes#standalone-mode). - -### Standalone - -When initiating a standalone WebdriverIO session, just wrap the `remote` call with the `setupForDevtools` exported by the package as follows: - -```ts -import { remote } from 'webdriverio' -import { setupForDevtools } from '@wdio/devtools-service' +or with pnpm: -const browser = await remote(setupForDevtools({ - capabilities: { - browserName: 'chrome', - browserVersion: 'latest' - } -})) - -// call commands -// ... - -await browser.deleteSession() +```sh +pnpm add -D @wdio/devtools-service ``` -### Testrunner +## Usage + +### WebdriverIO Test Runner -To integrate WebdriverIO Devtools in your test runner, just add this service to your `wdio.conf.js` as follows: +Add the service to your `wdio.conf.ts`: -```ts -export const config: WebdriverIO.Config = { +```js +export const config = { // ... - services: ['devtools'] + services: ['devtools'], // ... } ``` diff --git a/packages/service/package.json b/packages/service/package.json index 640b70a..5b9d866 100644 --- a/packages/service/package.json +++ b/packages/service/package.json @@ -1,6 +1,6 @@ { "name": "@wdio/devtools-service", - "version": "10.2.0", + "version": "10.2.1", "description": "Hook up WebdriverIO with DevTools", "author": "Christian Bromann ", "repository": {