You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+33-5Lines changed: 33 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,15 +8,39 @@
8
8
<ahref="https://github.com/guidepup/guidepup-playwright/blob/main/LICENSE"><imgalt="@guidepup/playwright uses the MIT license"src="https://img.shields.io/github/license/guidepup/guidepup-playwright" /></a>
9
9
</p>
10
10
<palign="center">
11
-
Providing a reliable set of APIs to automate your screen reader a11y workflows in Playwright.
11
+
Reliable automation for your screen reader a11y workflows in Playwright supporting:
12
12
</p>
13
+
<palign="center">
14
+
<ahref="https://www.guidepup.dev/docs/api/class-voiceover"><b>VoiceOver on MacOS</b></a>
15
+
</p>
16
+
<palign="center">
17
+
<b>NVDA on Windows</b> - <ahref="https://github.com/guidepup/guidepup/pull/33">Coming Soon!</a>
18
+
</p>
19
+
20
+
## Intro
21
+
22
+
A11y static analysis tools [only cover 25% of WCAG](https://karlgroves.com/web-accessibility-testing-what-can-be-tested-and-how/) and don't assure on the quality of the user experience for screen reader users. This means teams need to perform lots of manual tests with multiple screen readers to ensure great UX which can take a lot of time... **not anymore!**
23
+
24
+
With [Guidepup](https://www.guidepup.dev/) you can automate your screen reader test workflows the same you as would for mouse or keyboard based scenarios, no sweat!
25
+
26
+
## Quick Features
27
+
28
+
-**Full Control** - if a screen reader has a keyboard command, then Guidepup supports it.
29
+
-**Mirrors Real User Experience** - assert on what users really do and hear when using screen readers.
30
+
-**Framework Agnostic** - run with Jest, with Playwright, as an independent script, no vendor lock-in.
13
31
14
32
## Getting Started
15
33
34
+
Set up your environment for screen reader automation with [`@guidepup/setup`](https://github.com/guidepup/setup):
And get cracking with your first screen reader tests in Playwright!
@@ -68,7 +92,7 @@ Check out the configuration this adds [in the voConfig.ts file](./src/voConfig.t
68
92
69
93
## Environment Setup
70
94
71
-
Setup your environment for screen-read automation with [`@guidepup/setup`](https://github.com/guidepup/setup):
95
+
Set up your environment for screen-read automation with [`@guidepup/setup`](https://github.com/guidepup/setup):
72
96
73
97
```bash
74
98
npx @guidepup/setup
@@ -78,12 +102,16 @@ If you are using GitHub Actions, check out the dedicated [`guidepup/setup-action
78
102
79
103
```yaml
80
104
-name: SetupEnvironment
81
-
uses: guidepup/setup-action@0.7.0
105
+
uses: guidepup/setup-action@0.8.1
82
106
```
83
107
108
+
## Documentation
109
+
110
+
Head over to the [Guidepup Website](https://www.guidepup.dev/) for guides, real world examples, environment setup, and complete Guidepup API documentation with examples.
111
+
84
112
## Example
85
113
86
-
Check out [this VoiceOver example](./example/).
114
+
Check out [this cross-browser VoiceOver example](./example/).
0 commit comments