Skip to content

Commit 8e2089c

Browse files
committed
Update README
1 parent 2f90239 commit 8e2089c

File tree

1 file changed

+6
-56
lines changed

1 file changed

+6
-56
lines changed

README.md

Lines changed: 6 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -2,68 +2,18 @@
22

33
Imagine browsing pages (routes), receiving alerts and notifications, having a countdown timer on the page, a progress bar, a loading or a change of route in a SPA. Now imagine all this happening to people who have visual disabilities and who use screen readers.
44

5-
The [vue-announcer](https://github.com/vue-a11y/vue-announcer) provides an easy way to really tell what’s going on in your application to people using screen readers.
5+
The [@vue-a11y/announcer](https://github.com/vue-a11y/vue-announcer) (v2) provides an easy way to really tell what’s going on in your application to people using screen readers.
6+
7+
> For vue-announcer version 1.* you can access [this link](https://github.com/vue-a11y/vue-announcer/tree/v1.0.6)
68
79
Inspired by others in the community like:
810
- [Example of how creating an accessible single-page application](https://haltersweb.github.io/Accessibility/spa.html)
911
- [Ember A11y community](https://github.com/ember-a11y/a11y-announcer)
1012

11-
### Links
12-
13-
- [Documentation](https://announcer.vue-a11y.com/)
14-
- [Demos](https://announcer.vue-a11y.com/demos/)
15-
16-
## Install package
17-
#### NPM
18-
```shell
19-
npm install -S vue-announcer
20-
```
21-
22-
#### Yarn
23-
```shell
24-
yarn add vue-announcer
25-
```
26-
---
27-
28-
# Installation
29-
30-
## Package
31-
32-
#### NPM
33-
```shell
34-
npm install -S vue-announcer
35-
```
36-
37-
#### Yarn
38-
```shell
39-
yarn add vue-announcer
40-
```
41-
42-
## Basic usage
43-
44-
```javascript
45-
import Vue from 'vue'
46-
import VueAnnouncer from 'vue-announcer'
47-
48-
Vue.use(VueAnnouncer)
49-
```
50-
51-
In your `App.vue`
52-
```vue
53-
<template>
54-
<div>
55-
<vue-announcer />
56-
<!-- header code -->
57-
<!-- router-view -->
58-
<!-- footer code -->
59-
</div>
60-
</template>
61-
```
62-
63-
[see more in the documentation](https://announcer.vue-a11y.com/)
13+
## Links
6414

65-
## Check live demo
66-
https://vue-announcer.surge.sh/
15+
- [Documentation](https://vue-announcer-v2.surge.sh)
16+
- [Demos](https://vue-announcer-v2.surge.sh/demos/)
6717

6818
## Run the tests
6919
```shell

0 commit comments

Comments
 (0)