Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
- Remove test script in favor of gulp
  • Loading branch information
ckundo committed Jan 22, 2016
1 parent 040ebf7 commit 8b48993
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 18 deletions.
39 changes: 25 additions & 14 deletions README.md
Expand Up @@ -2,20 +2,30 @@

# Accessibility Monitoring for Your Website

AccessLint Monitor will alert you of accessibility errors in your website.
AccessLint.js warns you of accessibility errors in your website.

## Usage

Install AccessLint Monitor by including the javascript in at the end of any page
you want to monitor.
Install AccessLint.js by including the javascript in at the end of any page you
want to monitor.

Include the compiled library through the AccessLint CDN:

```
<script src="http://cdn.accesslint.com/accesslint-0.1.js" type="text/javascript">
```

## How it works

AccessLint Monitor is similar to client side performance measurement tools like
NewRelic or Google Analytics in the way it is included and run on your website.
When a visitor arrives at a page that has the script installed, an audit will
run in the background automatically. If there are any accessibility issues on
that page, AccessLint Monitor track the error for review.
that page, AccessLint.js will raise the error and track it for review.

AccessLint.js runs assertions from the
[aXe-core](https://github.com/dequelabs/axe-core) accessibility library wherever
you include the script. It the raises JavaScript errors in the page and posts
results to the [AccessLint service](https://beta.accesslint.com), where you can
add reporting and notification integrations.

## Development

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

$ bin/setup

### Testing

$ gulp

### Building

#### Development

$ gulp build-dev
$ gulp build-dev # build and watch for changes

#### Production

$ gulp build

### Testing

From the application root: `$ karma start`
### Deploying

#### Smoke testing
AccessLint.js is hosted on Amazon S3 behind Cloudfront. You must have AWS
credentials with the AccessLint account to publish an updated version.

1. Start the node test app `$ DEBUG=express:* node test/integration/app.js`.
1. Visit `localhost:3000`.
1. Open the network panel and review the response from the host.
$ gulp publish
2 changes: 1 addition & 1 deletion bin/setup
@@ -1,4 +1,4 @@
#!/usr/bin/env sh

npm install -g webpack gulp-cli
npm install -g gulp-cli webpack
npm install
3 changes: 0 additions & 3 deletions package.json
Expand Up @@ -12,9 +12,6 @@
"testing",
"a11y"
],
"scripts": {
"test": "gulp build-dev && ./node_modules/.bin/karma start --single-run"
},
"author": "Cameron Cundiff",
"license": "MIT",
"bugs": {
Expand Down

0 comments on commit 8b48993

Please sign in to comment.