@reticular/speakable 1.0.1 → 1.0.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +9 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -2,6 +2,8 @@
|
|
|
2
2
|
|
|
3
3
|
Simulate how NVDA, JAWS, and VoiceOver interpret your HTML — from a single CLI tool. Catch screen reader issues early, detect regressions in CI/CD, and reduce manual testing overhead.
|
|
4
4
|
|
|
5
|
+
**Try it in your browser — no install needed:** [getspeakable.dev/tool](https://getspeakable.dev/tool)
|
|
6
|
+
|
|
5
7
|
Speakable bridges the gap between rule-based linting tools (like axe) and manual screen reader testing. It gives you scalable, automated insight into how assistive technologies will interpret your UI.
|
|
6
8
|
|
|
7
9
|
> Screen reader output is heuristic and may differ from actual behavior. Speakable complements manual testing — it doesn't replace it.
|
|
@@ -37,6 +39,12 @@ speakable new.html --diff old.html
|
|
|
37
39
|
cat page.html | speakable -
|
|
38
40
|
```
|
|
39
41
|
|
|
42
|
+
> For quick one-off checks, you can also paste HTML directly into the [web analyzer](https://getspeakable.dev/tool) — same engine, no setup.
|
|
43
|
+
|
|
44
|
+
## Web Analyzer
|
|
45
|
+
|
|
46
|
+
If you want to test HTML quickly without installing anything, paste it directly into the web analyzer at [getspeakable.dev/tool](https://getspeakable.dev/tool). It runs the same simulation engine in the browser — supports NVDA, JAWS, and VoiceOver output, CSS selector filtering, and diff mode. Useful for quick iteration, debugging a specific component, or sharing results with teammates who don't have the CLI installed.
|
|
47
|
+
|
|
40
48
|
## CLI Reference
|
|
41
49
|
|
|
42
50
|
```
|
|
@@ -245,6 +253,7 @@ Use Speakable to catch issues early and reduce the manual testing burden — the
|
|
|
245
253
|
4. **Check all readers** — Use `-s all` to see cross-platform differences
|
|
246
254
|
5. **Start with audit** — Use `-f audit` for a quick overview of accessibility health
|
|
247
255
|
6. **Save baselines** — Store JSON output as baselines for regression detection
|
|
256
|
+
7. **Use the web tool for debugging** — Paste HTML into [getspeakable.dev/tool](https://getspeakable.dev/tool) when you need fast visual feedback during development
|
|
248
257
|
|
|
249
258
|
## Requirements
|
|
250
259
|
|