Skip to content

Commit 8b48993

Browse files
committed
Update documentation
- Remove test script in favor of gulp
1 parent 040ebf7 commit 8b48993

File tree

3 files changed

+26
-18
lines changed

3 files changed

+26
-18
lines changed

README.md

Lines changed: 25 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2,20 +2,30 @@
22

33
# Accessibility Monitoring for Your Website
44

5-
AccessLint Monitor will alert 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 Monitor by including the javascript in at the end of any page
10-
you want to monitor.
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:
13+
14+
```
15+
<script src="http://cdn.accesslint.com/accesslint-0.1.js" type="text/javascript">
16+
```
1117

1218
## How it works
1319

14-
AccessLint Monitor is similar to client side performance measurement tools like
15-
NewRelic or Google Analytics in the way it is included and run on your website.
1620
When a visitor arrives at a page that has the script installed, an audit will
1721
run in the background automatically. If there are any accessibility issues on
18-
that page, AccessLint Monitor track the error for review.
22+
that page, AccessLint.js will raise the error and track it for review.
23+
24+
AccessLint.js runs assertions from the
25+
[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.
1929

2030
## Development
2131

@@ -26,22 +36,23 @@ code for inclusion clientside. It uses karma and mocha to run tests.
2636

2737
$ bin/setup
2838

39+
### Testing
40+
41+
$ gulp
42+
2943
### Building
3044

3145
#### Development
3246

33-
$ gulp build-dev
47+
$ gulp build-dev # build and watch for changes
3448

3549
#### Production
3650

3751
$ gulp build
3852

39-
### Testing
40-
41-
From the application root: `$ karma start`
53+
### Deploying
4254

43-
#### Smoke testing
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.
4457

45-
1. Start the node test app `$ DEBUG=express:* node test/integration/app.js`.
46-
1. Visit `localhost:3000`.
47-
1. Open the network panel and review the response from the host.
58+
$ gulp publish

bin/setup

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
#!/usr/bin/env sh
22

3-
npm install -g webpack gulp-cli
3+
npm install -g gulp-cli webpack
44
npm install

package.json

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,6 @@
1212
"testing",
1313
"a11y"
1414
],
15-
"scripts": {
16-
"test": "gulp build-dev && ./node_modules/.bin/karma start --single-run"
17-
},
1815
"author": "Cameron Cundiff",
1916
"license": "MIT",
2017
"bugs": {

0 commit comments

Comments
 (0)