Skip to content

Commit 3cfa6d8

Browse files
author
Cameron Cundiff
committed
Remove CDN instructions from README, rely on releases
1 parent b1a9c36 commit 3cfa6d8

File tree

1 file changed

+12
-18
lines changed

1 file changed

+12
-18
lines changed

README.md

Lines changed: 12 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -2,30 +2,31 @@
22

33
# Accessibility Monitoring for Your Website
44

5-
AccessLint.js warns you of accessibility errors in your website.
5+
accesslint.js warns you of accessibility errors in your website.
66

77
## Usage
88

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:
1311

1412
```
15-
<script src="https://cdn.accesslint.com/accesslint-0.1.js" type="text/javascript">
13+
<script src="accesslint.js" type="text/javascript">
1614
```
1715

1816
## How it works
1917

2018
When a visitor arrives at a page that has the script installed, an audit will
2119
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.
2322

24-
AccessLint.js runs assertions from the
23+
accesslint.js runs assertions from the
2524
[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.
2930

3031
## Development
3132

@@ -49,10 +50,3 @@ code for inclusion clientside. It uses karma and mocha to run tests.
4950
#### Production
5051

5152
$ 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

Comments
 (0)