@axe-core/reporter-earl 4.4.3-alpha.261 → 4.4.3-alpha.262

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.
Files changed (2) hide show
  1. package/README.md +17 -0
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -16,6 +16,23 @@ npm install @axe-core/reporter-earl
16
16
 
17
17
  The EARL reporter can be passed to axe, either as part of configuration or as part of the run:
18
18
 
19
+ CommonJS Require Syntax:
20
+
21
+ ```js
22
+ const reporter = require('@axe-core/reporter-earl').default;
23
+ // Define the reporter through axe.configure
24
+ axe.configure({ reporter });
25
+ axe.run().then(earlResults => console.log(earlResults));
26
+ ```
27
+
28
+ ```js
29
+ const reporter = require('@axe-core/reporter-earl').default;
30
+ // Use the reporter in a single axe.run call
31
+ axe.run({ reporter }).then(earlResults => console.log(earlResults));
32
+ ```
33
+
34
+ ES6 Import Syntax:
35
+
19
36
  ```js
20
37
  import reporter from '@axe-core/reporter-earl';
21
38
  // Define the reporter through axe.configure
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@axe-core/reporter-earl",
3
- "version": "4.4.3-alpha.261+e51581e",
3
+ "version": "4.4.3-alpha.262+3ac892a",
4
4
  "description": "A EARL+JSON-LD reporter for axe-core",
5
5
  "main": "dist/axeReporterEarl.js",
6
6
  "scripts": {
@@ -42,5 +42,5 @@
42
42
  "ts-node": "^7.0.1",
43
43
  "typescript": "^3.9.10"
44
44
  },
45
- "gitHead": "e51581ee81beb7d65dfd539f29cd50f05736b78b"
45
+ "gitHead": "3ac892a6ac1ec6c9de258493eda764f9031522e2"
46
46
  }