2
2
3
3
# Accessibility Monitoring for Your Website
4
4
5
- AccessLint .js warns you of accessibility errors in your website.
5
+ accesslint .js warns you of accessibility errors in your website.
6
6
7
7
## Usage
8
8
9
- Install AccessLint.js by including the javascript in at the end of any page you
10
- want to monitor.
11
-
12
- Include the compiled library through the AccessLint CDN:
9
+ Download the compiled library from the releases page or build it yourself. Then,
10
+ include the javascript in you page:
13
11
14
12
```
15
- <script src="https://cdn. accesslint.com/accesslint-0.1 .js" type="text/javascript">
13
+ <script src="accesslint.js" type="text/javascript">
16
14
```
17
15
18
16
## How it works
19
17
20
18
When a visitor arrives at a page that has the script installed, an audit will
21
19
run in the background automatically. If there are any accessibility issues on
22
- that page, AccessLint.js will raise the error and track it for review.
20
+ that page, accesslint.js will log the error to the console, and post to a server
21
+ endpoint that you can optionally configure.
23
22
24
- AccessLint .js runs assertions from the
23
+ accesslint .js runs assertions from the
25
24
[ aXe-core] ( https://github.com/dequelabs/axe-core ) accessibility library wherever
26
- you include the script. It the raises JavaScript errors in the page and posts
27
- results to the [ AccessLint service] ( https://beta.accesslint.com ) , where you can
28
- add reporting and notification integrations.
25
+ you include the script. It the logs the violations the browser's Javascript
26
+ console. It also POSTs the results to ` /access_lint/errors ` in your app. If you
27
+ set up and endpoint with that path, you can log the errors on the server too.
28
+ See [ AccessLint::Rails] ( https://github.com/thoughtbot/access_lint-rails ) for a
29
+ Rails implementation of server side logging of accessibility errors.
29
30
30
31
## Development
31
32
@@ -49,10 +50,3 @@ code for inclusion clientside. It uses karma and mocha to run tests.
49
50
#### Production
50
51
51
52
$ gulp build
52
-
53
- ### Deploying
54
-
55
- AccessLint.js is hosted on Amazon S3 behind Cloudfront. You must have AWS
56
- credentials with the AccessLint account to publish an updated version.
57
-
58
- $ gulp publish
0 commit comments