Skip to content

Commit

Permalink
docs: add npm badges, tweaks
Browse files Browse the repository at this point in the history
  • Loading branch information
goosewobbler committed Aug 19, 2024
1 parent 5b55264 commit b361808
Showing 1 changed file with 10 additions and 3 deletions.
13 changes: 10 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
# WDIO Electron Service

<a href="https://www.npmjs.com/package/wdio-electron-service" alt="NPM Version">
<img src="https://img.shields.io/npm/v/wdio-electron-service" /></a>
<a href="https://www.npmjs.com/package/wdio-electron-service" alt="NPM Downloads">
<img src="https://img.shields.io/npm/dw/wdio-electron-service" /></a>

<br />

**WebdriverIO service for testing Electron applications**

Enables cross-platform E2E testing of Electron apps via the extensive WebdriverIO ecosystem.
Expand All @@ -8,10 +15,10 @@ Spiritual successor to [Spectron](https://github.com/electron-userland/spectron)

### Features

Using the service makes testing Electron applications much easier:
Makes testing Electron applications much easier via:

- 🚗 auto-setup of required Chromedriver
- 📦 automatic path detection of your Electron application - supports [Electron Forge](https://www.electronforge.io/) and [Electron Builder](https://www.electron.build/)
- 📦 automatic path detection of your Electron application - supports [Electron Forge](https://www.electronforge.io/), [Electron Builder](https://www.electron.build/) and unpackaged apps
- 🧩 access Electron APIs within your tests
- 🕵️ mocking of Electron APIs via a Vitest-like API

Expand Down Expand Up @@ -118,7 +125,7 @@ Read the [development doc](./docs/development.md) if you are interested in contr

## Example Integrations

Check out our [Electron boilerplate](https://github.com/webdriverio/electron-boilerplate) project that showcases how to integrate WebdriverIO in an example application. You can also have a look at the [Example Apps](./apps/) and [E2Es](./packages/e2e/) directories in this repository.
Check out our [Electron boilerplate](https://github.com/webdriverio/electron-boilerplate) project that showcases how to integrate WebdriverIO in an example application. You can also have a look at the [Example Apps](./apps/) and [E2Es](./e2e/) directories in this repository.

## Support

Expand Down

0 comments on commit b361808

Please sign in to comment.