@guidepup/playwright 0.8.1 → 0.9.0

package/README.md

@@ -8,15 +8,39 @@
   <a href="https://github.com/guidepup/guidepup-playwright/blob/main/LICENSE"><img alt="@guidepup/playwright uses the MIT license" src="https://img.shields.io/github/license/guidepup/guidepup-playwright" /></a>
 </p>
 <p align="center">
-  Providing a reliable set of APIs to automate your screen reader a11y workflows in Playwright.
+  Reliable automation for your screen reader a11y workflows in Playwright supporting:
 </p>
+<p align="center">
+  <a href="https://www.guidepup.dev/docs/api/class-voiceover"><b>VoiceOver on MacOS</b></a>
+</p>
+<p align="center">
+  <b>NVDA on Windows</b> - <a href="https://github.com/guidepup/guidepup/pull/33">Coming Soon!</a>
+</p>
+
+## Intro
+
+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!**
+
+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!
+
+## Quick Features
+
+- **Full Control** - if a screen reader has a keyboard command, then Guidepup supports it.
+- **Mirrors Real User Experience** - assert on what users really do and hear when using screen readers.
+- **Framework Agnostic** - run with Jest, with Playwright, as an independent script, no vendor lock-in.
 
 ## Getting Started
 
+Set up your environment for screen reader automation with [`@guidepup/setup`](https://github.com/guidepup/setup):
+
+```console
+npx @guidepup/setup
+```
+
 Install `@guidepup/playwright` to your project:
 
-```bash
-npm install --save-dev @guidepup/playwright
+```console
+npm install --save-dev @guidepup/playwright @playwright/test
 ```
 
 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
 
 ## Environment Setup
 
-Setup your environment for screen-read automation with [`@guidepup/setup`](https://github.com/guidepup/setup):
+Set up your environment for screen-read automation with [`@guidepup/setup`](https://github.com/guidepup/setup):
 
 ```bash
 npx @guidepup/setup
@@ -78,12 +102,16 @@ If you are using GitHub Actions, check out the dedicated [`guidepup/setup-action
 
 ```yaml
 - name: Setup Environment
-  uses: guidepup/setup-action@0.7.0
+  uses: guidepup/setup-action@0.8.1
 ```
 
+## Documentation
+
+Head over to the [Guidepup Website](https://www.guidepup.dev/) for guides, real world examples, environment setup, and complete Guidepup API documentation with examples.
+
 ## Example
 
-Check out [this VoiceOver example](./example/).
+Check out [this cross-browser VoiceOver example](./example/).
 
 ## See Also
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@guidepup/playwright",
-  "version": "0.8.1",
+  "version": "0.9.0",
   "description": "Screen reader driver for Playwright tests.",
   "main": "lib/index.js",
   "typings": "lib/index.d.ts",
@@ -36,10 +36,10 @@
     "test:webkit": "playwright test --config ./example/webkit.config.ts ./example/tests/webkit/"
   },
   "dependencies": {
-    "@guidepup/guidepup": "^0.15.2"
+    "@guidepup/guidepup": "^0.16.0"
   },
   "devDependencies": {
-    "@playwright/test": "^1.29.2",
+    "@playwright/test": "^1.30.0",
     "@types/node": "^18.11.18",
     "@typescript-eslint/eslint-plugin": "^5.5.0",
     "@typescript-eslint/parser": "^5.5.0",

package/yarn.lock

@@ -24,10 +24,10 @@
     minimatch "^3.1.2"
     strip-json-comments "^3.1.1"
 
-"@guidepup/guidepup@^0.15.2":
-  version "0.15.2"
-  resolved "https://registry.yarnpkg.com/@guidepup/guidepup/-/guidepup-0.15.2.tgz#d93d686515a0f731f1a6346ced365e953feb5216"
-  integrity sha512-kTKQu2huvMIUkupbUCn/qHOopPw3cvoDRJrElGMkBE74PCpqkuQDJGa/X8H7VvahAgndErtlUm/E4aaYTR4x/Q==
+"@guidepup/guidepup@^0.16.0":
+  version "0.16.0"
+  resolved "https://registry.yarnpkg.com/@guidepup/guidepup/-/guidepup-0.16.0.tgz#a09841d8594d2b000c7b114a45332890da72c6e9"
+  integrity sha512-kHmhIAkFn05FYT/MgHBc4iXi6OVsiDeiY4g6mp77p0brcf9HZhcY+iko+bVhW2jPWuJNysVTUbDNlOYUsrM43w==
 
 "@humanwhocodes/config-array@^0.11.8":
   version "0.11.8"
@@ -87,13 +87,13 @@
     "@nodelib/fs.scandir" "2.1.5"
     fastq "^1.6.0"
 
-"@playwright/test@^1.29.2":
-  version "1.29.2"
-  resolved "https://registry.yarnpkg.com/@playwright/test/-/test-1.29.2.tgz#c48184721d0f0b7627a886e2ec42f1efb2be339d"
-  integrity sha512-+3/GPwOgcoF0xLz/opTnahel1/y42PdcgZ4hs+BZGIUjtmEFSXGg+nFoaH3NSmuc7a6GSFwXDJ5L7VXpqzigNg==
+"@playwright/test@^1.30.0":
+  version "1.30.0"
+  resolved "https://registry.yarnpkg.com/@playwright/test/-/test-1.30.0.tgz#8c0c4930ff2c7be7b3ec3fd434b2a3b4465ed7cb"
+  integrity sha512-SVxkQw1xvn/Wk/EvBnqWIq6NLo1AppwbYOjNLmyU0R1RoQ3rLEBtmjTnElcnz8VEtn11fptj1ECxK0tgURhajw==
   dependencies:
     "@types/node" "*"
-    playwright-core "1.29.2"
+    playwright-core "1.30.0"
 
 "@tsconfig/node10@^1.0.7":
   version "1.0.9"
@@ -855,10 +855,10 @@ picomatch@^2.3.1:
   resolved "https://registry.yarnpkg.com/picomatch/-/picomatch-2.3.1.tgz#3ba3833733646d9d3e4995946c1365a67fb07a42"
   integrity sha512-JU3teHTNjmE2VCGFzuY8EXzCDVwEqB2a8fsIvwaStHhAWJEeVd1o1QD80CU6+ZdEXXSLbSsuLwJjkCBWqRQUVA==
 
-playwright-core@1.29.2:
-  version "1.29.2"
-  resolved "https://registry.yarnpkg.com/playwright-core/-/playwright-core-1.29.2.tgz#2e8347e7e8522409f22b244e600e703b64022406"
-  integrity sha512-94QXm4PMgFoHAhlCuoWyaBYKb92yOcGVHdQLoxQ7Wjlc7Flg4aC/jbFW7xMR52OfXMVkWicue4WXE7QEegbIRA==
+playwright-core@1.30.0:
+  version "1.30.0"
+  resolved "https://registry.yarnpkg.com/playwright-core/-/playwright-core-1.30.0.tgz#de987cea2e86669e3b85732d230c277771873285"
+  integrity sha512-7AnRmTCf+GVYhHbLJsGUtskWTE33SwMZkybJ0v6rqR1boxq2x36U7p1vDRV7HO2IwTZgmycracLxPEJI49wu4g==
 
 prelude-ls@^1.2.1:
   version "1.2.1"