wcag-scanner 1.2.56 → 1.2.58
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 +8 -6
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -18,6 +18,8 @@ WCAG Scanner is a powerful accessibility testing tool that helps developers iden
|
|
|
18
18
|
|
|
19
19
|
|
|
20
20
|
|
|
21
|
+
<div align="center"><img src="https://codecov.io/gh/sinhaparth5/wcag-scanner/graphs/sunburst.svg?token=TOJOPXNYGV" alt="CodeCov Sunburst" /> </div>
|
|
22
|
+
|
|
21
23
|
## ✨ Features
|
|
22
24
|
|
|
23
25
|
- **Comprehensive Accessibility Testing**: Scans websites against WCAG 2.1 A, AA, and AAA compliance levels
|
|
@@ -42,18 +44,18 @@ yarn add wcag-scanner
|
|
|
42
44
|
```
|
|
43
45
|
|
|
44
46
|
## How to use
|
|
47
|
+
### CLI Usage Example:
|
|
45
48
|
|
|
46
|
-
### Scan a file
|
|
47
49
|
```bash
|
|
50
|
+
# Scan a file
|
|
48
51
|
npx wcag-scanner file index.html --level AA --format console
|
|
49
|
-
```
|
|
50
52
|
|
|
51
|
-
|
|
52
|
-
```bash
|
|
53
|
+
# Scan a URL
|
|
53
54
|
npx wcag-scanner url https://example.com --format html --output report.html
|
|
54
55
|
```
|
|
55
56
|
|
|
56
|
-
###
|
|
57
|
+
### Express Middleware Usage Example:
|
|
58
|
+
|
|
57
59
|
```JavaScript
|
|
58
60
|
import express from 'express';
|
|
59
61
|
import { middleware } from 'wcag-scanner';
|
|
@@ -92,7 +94,7 @@ app.listen(3000, () => {
|
|
|
92
94
|
});
|
|
93
95
|
```
|
|
94
96
|
|
|
95
|
-
###
|
|
97
|
+
### Programmatic API Usage Example:
|
|
96
98
|
```JavaScript
|
|
97
99
|
import { scanHtml, scanUrl, formatReport } from 'wcag-scanner';
|
|
98
100
|
|