Skip to content

Commit a41b22c

Browse files
Update README with Axe-Core trademark
1 parent 9c0f3af commit a41b22c

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,9 @@
77
[![NPM release](https://img.shields.io/npm/v/axe-playwright.svg 'NPM release')](https://www.npmjs.com/package/axe-playwright)
88
[![NPM Downloads](https://img.shields.io/npm/dt/axe-playwright.svg?style=flat-square)](https://www.npmjs.com/package/axe-playwright)
99

10-
[Axe](https://www.deque.com/axe/) is an accessibility testing engine for websites and other HTML-based user interfaces. This package provides simple axe analyser commands which you can incorporate in your [Playwright](https://www.npmjs.com/package/playwright) tests. [Axe](https://www.deque.com/axe/) seamlessly functions across all Playwright browsers: Chromium, Firefox, and WebKit.
10+
Axe-core® is a powerful accessibility testing engine provided by Deque Systems that powers this package. Axe-Playwright provides simple commands to integrate the axe-core® library with your [Playwright](https://www.npmjs.com/package/playwright) tests. This integration functions seamlessly across all Playwright browsers: Chromium, Firefox, and WebKit.
11+
12+
Axe-core® is a trademark of [Deque Systems, Inc.](https://www.deque.com/) in the US and other countries. This project is not formally affiliated with Deque, but we are big fans! Axe-core® is a registered trademark of Deque Systems, Inc., and is used here with permission.
1113

1214
## Install and configure
1315

@@ -23,7 +25,7 @@ npm i -D axe-playwright
2325
npm i -D playwright
2426
```
2527

26-
**NOTE:** _axe-core is now bundled and doesn't need to be installed as a peer dependency_
28+
NOTE: axe-core® is now bundled and doesn't need to be installed separately.
2729

2830
### Add Typings
2931

@@ -40,7 +42,7 @@ npm i -D playwright
4042

4143
### injectAxe
4244

43-
This will inject the `axe-core` runtime into the page under test. You must run this **after** a call to `page.goto()` and before you run the `checkA11y` command.
45+
This will inject the axe-core® runtime into the page under test. You must run this after a call to page.goto() and before you run the checkA11y command.
4446

4547
You run this command with `injectAxe()` either in your test, or in a `beforeEach`, as long as the `visit` comes first.
4648

0 commit comments

Comments
 (0)