Skip to content

Commit 337451d

Browse files
committed
chore: Update README to next version
1 parent 2d4bed8 commit 337451d

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
@@ -14,19 +14,19 @@ https://www.w3.org/TR/WCAG20-TECHS/G124.html
1414
## Install
1515
#### NPM
1616
```shell
17-
npm install -S vue-skip-to
17+
npm install -S @vue-a11y/skip-to
1818
```
1919

2020
#### Yarn
2121
```shell
22-
yarn add vue-skip-to
22+
yarn add @vue-a11y/skip-to
2323
```
2424

2525
## How to use
2626
In your `main.js`
2727
```javascript
2828
import Vue from 'vue'
29-
import VueSkipTo from 'vue-skip-to'
29+
import VueSkipTo from '@vue-a11y/skip-to'
3030

3131
Vue.use(VueSkipTo)
3232

@@ -39,7 +39,7 @@ In your `App.vue`
3939
```vue
4040
<template>
4141
<div id="app">
42-
<vue-skip-to to="#main" text="Skip to main content" />
42+
<VueSkipTo to="#main" text="Skip to main content" />
4343
4444
<logo :src="require('@/assets/logo.png')" />
4545
<h1 data-va="main header">{{ msg }}</h1>
@@ -63,6 +63,9 @@ export default {
6363
## Using with HTML files
6464
```html
6565
<!--omitted -->
66+
<script src="https://unpkg.com/vue"></script>
67+
<script src="https://unpkg.com/@vue-a11y/skip-to"></script>
68+
</head>
6669
<body>
6770
<div id="app">
6871
<vue-skip-to to="#main"></vue-skip-to>
@@ -74,14 +77,10 @@ export default {
7477
</div>
7578
</div>
7679

77-
<script src="https://unpkg.com/vue"></script>
78-
<script src="https://unpkg.com/vue-skip-to"></script>
7980
<script>
80-
Vue.use(VueSkipTo)
8181
new Vue({
8282
el: "#app"
8383
})
84-
8584
</script>
8685
</body>
8786
</html>
@@ -96,8 +95,6 @@ Prop | Data Type | required | Description | Default
9695
--------------- | ---------- | --------- | ---------------------- | -------------
9796
`to` | String | false | Set destination ID | #main
9897
`text` | String | false | Text content of link | Skip to main content
99-
`tabindex` | String | false | Specifies the tab order | null
100-
10198

10299
## Custom style
103100
You can style the link through the selector `.vue-skip-to`
@@ -113,25 +110,22 @@ http://www.nczonline.net/blog/2013/01/15/fixing-skip-to-content-links/
113110
## Run the tests
114111

115112
```shell
116-
git clone https://github.com/vue-a11y/vue-skip-to.git vue-skip-to
113+
git clone https://github.com/vue-a11y/vue-skip-to.git
117114
npm install
118115
npm run dev
119-
npm run test
116+
npm run test:e2e
120117
```
121118

122119
Or run Cypress on interactive mode
123120
```shell
124-
npm run test:open
121+
npm run test:e2e:open
125122
```
126123

127-
## Roadmap
128-
https://github.com/vue-a11y/vue-skip-to/issues/1
129-
130124
## Contributing
125+
- From typos in documentation to coding new features;
131126
- Check the open issues or open a new issue to start a discussion around your feature idea or the bug you found;
132127
- Fork repository, make changes and send a pull request;
133128

134-
If you want a faster communication, find me on [@ktquez](https://twitter.com/ktquez)
135-
And follow us on Twitter [@vue_a11y](https://twitter.com/vue_a11y)
129+
Follow us on Twitter [@vue_a11y](https://twitter.com/vue_a11y)
136130

137131
**Thank you**

0 commit comments

Comments
 (0)