Skip to content

Commit 5ef04ad

Browse files
docs: fix readme example
1 parent 73155c8 commit 5ef04ad

File tree

1 file changed

+7
-11
lines changed

1 file changed

+7
-11
lines changed

README.md

Lines changed: 7 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,6 @@ With Guidepup Virtual Screen Reader you can automate your screen reader unit tes
2020

2121
## Upcoming Features
2222

23-
🚧🚧🚧 **WIP** 🚧🚧🚧
24-
25-
This project is currently a work in progress, but here are some of the features you can expect from this package as it matures:
26-
2723
- **Mirrors Real User Experience** - assert on what users really do and hear when using screen readers.
2824
- **Test Framework Agnostic** - run with Jest, with Playwright, as an independent script, no vendor lock-in.
2925
- **UI Framework Agnostic** - want to use React, Vue, Solid, Svelte, etc.? All good here! Works with any UI framework, and plays nicely with the [Testing Library](https://testing-library.com/) suite.
@@ -46,11 +42,11 @@ function setupBasicPage() {
4642
document.body.innerHTML = `
4743
<nav>Nav Text</nav>
4844
<section>
49-
<h1>Section Heading 1</h1>
45+
<h1>Section Heading</h1>
5046
<p>Section Text</p>
5147
<article>
5248
<header>
53-
<h1>Article Header Heading 1</h1>
49+
<h1>Article Header Heading</h1>
5450
<p>Article Header Text</p>
5551
</header>
5652
<p>Article Text</p>
@@ -61,7 +57,7 @@ function setupBasicPage() {
6157
}
6258

6359
describe("Screen Reader Tests", () => {
64-
test("should traverse the page announcing the expected roles and content", () => {
60+
test("should traverse the page announcing the expected roles and content", async () => {
6561
// Setup a page using a framework and testing library of your choice
6662
setupBasicPage();
6763

@@ -80,11 +76,11 @@ describe("Screen Reader Tests", () => {
8076
"Nav Text",
8177
"end of navigation",
8278
"region",
83-
"heading, Section Heading 1",
79+
"heading, Section Heading, level 1",
8480
"Section Text",
8581
"article",
8682
"banner",
87-
"heading, Article Header Heading 1",
83+
"heading, Article Header Heading, level 1",
8884
"Article Header Text",
8985
"end of banner",
9086
"Article Text",
@@ -97,7 +93,7 @@ describe("Screen Reader Tests", () => {
9793
]);
9894

9995
// Stop your virtual screen reader instance
100-
await voiceOver.stop();
96+
await virtual.stop();
10197
});
10298
});
10399
```
@@ -107,7 +103,7 @@ describe("Screen Reader Tests", () => {
107103
Check out some of the other Guidepup modules:
108104

109105
- [`@guidepup/guidepup`](https://github.com/guidepup/guidepup/) - reliable automation for your screen reader a11y workflows through JavaScript supporting VoiceOver and NVDA.
110-
- [`@guidepup/playwright`](https://github.com/guidepup/guidepup-playwright/) - seemless integration of Guidepup with Playwright.
106+
- [`@guidepup/playwright`](https://github.com/guidepup/guidepup-playwright/) - seamless integration of Guidepup with Playwright.
111107

112108
## Similar
113109

0 commit comments

Comments
 (0)