Skip to content

Commit

Permalink
docs(getting-started): noting ember-cli-ally, unpkg.com - closes #96
Browse files Browse the repository at this point in the history
  • Loading branch information
rodneyrehm committed Sep 11, 2016
1 parent 1d21f30 commit fd74412
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ layout: doc-page.html

ally.js is a JavaScript library simplifying certain accessibility features, functions and behaviors. However, simply loading ally.js will not automagically make a web application accessible. The library provides certain standard functions the "web platform" should've provided itself, so JavaScript applications be made accessible more easily. This document covers how to import ally.js in your project - see the [API documentation](api/README.md) to learn what the library actually provides.


## Requirements

In order to load successfully in IE8, the [es5-shim](https://github.com/es-shims/es5-shim/) has to be loaded. Please also see [Does ally.js support Internet Explorer 8 and below?](./questions.md##Does-ally-js-support-Internet-Explorer-8-and-below).
Expand Down Expand Up @@ -51,6 +52,15 @@ ally.js is also available for production use by [cdnjs](https://cdnjs.com/librar
</script>
```

ally.js is also available via [unpkg.com](https://unpkg.com):

```html
<script src="https://unpkg.com/ally.js@{{pkg.version}}/ally.min.js"></script>
<script>
console.log('loaded ally.js in version', ally.version);
console.log('focusable elements', ally.query.focusable());
</script>
```

## Installing via package manager

Expand Down Expand Up @@ -169,6 +179,11 @@ require(['ally.js/query/focusable'], function(queryFocusable) {
* **NOTE:** The AMD modules are only available through [npm](https://www.npmjs.com/package/ally.js) and [`ally.js.zip`](https://github.com/medialize/ally.js/releases/download/{{pkg.version}}/ally.js.zip).


## Integrations

* [ember-cli-ally](https://www.npmjs.com/package/ember-cli-ally) exposes ally.js to ember-cli apps as 'ally'


---

Continue with checking out one of the [Tutorials](tutorials/README.md) or head on to the [API documentation](api/README.md)

0 comments on commit fd74412

Please sign in to comment.