Skip to content

Commit 5cee327

Browse files
Updating the readme
1 parent b7e72e9 commit 5cee327

File tree

1 file changed

+16
-20
lines changed

1 file changed

+16
-20
lines changed

README.md

Lines changed: 16 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -31,19 +31,22 @@ Vue.use(VueScrollProgressBar)
3131
Or use the component directly:
3232

3333
```js
34-
import Vue from 'vue'
3534
import { VueScrollProgressBar } from '@guillaumebriday/vue-scroll-progress-bar'
3635

37-
Vue.component("vue-scroll-progress-bar", VueScrollProgressBar)
36+
export default {
37+
components: {
38+
VueScrollProgressBar
39+
},
40+
41+
// ...
42+
}
3843
```
3944

4045
## Basic Usage
4146

4247
```html
4348
<template>
44-
<div id="app">
45-
<vue-scroll-progress-bar @complete="handleComplete" height="2rem" />
46-
</div>
49+
<vue-scroll-progress-bar @complete="handleComplete" height="2rem" />
4750
</template>
4851
```
4952

@@ -81,28 +84,21 @@ With :
8184
## Develop
8285

8386
## Project setup
84-
```
85-
$ cd examples
87+
```bash
8688
$ yarn install
89+
$ yarn build -w
8790
```
8891

89-
### Compiles and hot-reloads for development
90-
```
91-
$ yarn run serve
92-
```
93-
94-
### Compiles and minifies for production
95-
```
96-
$ yarn run build
97-
```
92+
## Open example app
9893

99-
### Run your tests
100-
```
101-
$ yarn run test
94+
```bash
95+
$ cd example
96+
$ yarn
97+
$ yarn serve
10298
```
10399

104100
### Lints and fixes files
105-
```
101+
```bash
106102
$ yarn run lint
107103
```
108104

0 commit comments

Comments
 (0)