@webability/core 1.3.0 → 1.4.0

package/README.md

@@ -35,6 +35,58 @@ import { scan } from '@webability/core'
 const result = await scan(page)
 ```
 
+## Playwright test helper
+
+`@webability/core/playwright` is the new home of the old `@webability/playwright` package — same API, one less dependency. Needs `playwright` installed (optional peer).
+
+```typescript
+import { test, expect } from '@playwright/test'
+import { a11yCheck, WebAbility } from '@webability/core/playwright'
+
+test('homepage is accessible', async ({ page }) => {
+  await page.goto('/')
+  const result = await a11yCheck(page)
+  expect(result.summary.critical).toBe(0)
+})
+
+test('no new issues during checkout flow', async ({ page }) => {
+  const wa = new WebAbility(page)
+  await wa.start()
+  await page.goto('/cart')
+  await page.click('text=Checkout')
+  const result = await wa.stop() // merged issues across the whole flow
+  expect(result.summary.critical).toBe(0)
+})
+```
+
+For mobile coverage, emulate the device first — the engine includes touch-target (2.5.8), reflow (1.4.10), and zoom (1.4.4) checks:
+
+```typescript
+import { chromium, devices } from 'playwright'
+
+const browser = await chromium.launch()
+const page = await browser.newPage({ ...devices['iPhone 14'] })
+await page.goto('https://example.com')
+const result = await scan(page)
+```
+
+## In-DOM and component scans
+
+`@webability/core/dom` runs the full engine against a live `document` — no browser automation. Use it in jsdom component tests, content scripts, or any in-browser consumer:
+
+```typescript
+// component.test.tsx (jsdom environment)
+import { scanDocument } from '@webability/core/dom'
+
+test('login form is accessible', async () => {
+  render(<LoginForm />)
+  const result = await scanDocument()
+  expect(result.summary.critical).toBe(0)
+})
+```
+
+Same detectors, same dedupe, same axe-core pass as a full page scan.
+
 ## Options
 
 ```typescript