Skip to content

Commit 1d9896f

Browse files
committed
update README, version number
1 parent f0f493f commit 1d9896f

File tree

3 files changed

+4076
-5
lines changed

3 files changed

+4076
-5
lines changed

README.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
> Vue component that emits an event when scrolled into view
44
5+
[![vue-visibility-trigger demo](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/qkyolorn6w?module=%2Fsrc%2FApp.vue)
6+
57
## Installation
68

79
Install the package from npm by running
@@ -13,7 +15,7 @@ $ yarn add vue-visibility-trigger
1315
or
1416

1517
```
16-
$ npm install --save vue-visibility-trigger
18+
$ npm i vue-visibility-trigger
1719
```
1820

1921
## Usage
@@ -23,7 +25,7 @@ Import, register and place the component in your Vue app. Attach a function to r
2325
```
2426
<template>
2527
...
26-
<vue-visibility-trigger @scrolledIn="doSomething" />
28+
<VueVisibilityTrigger @scrolledIn="doSomething" />
2729
...
2830
</template>
2931
@@ -33,10 +35,12 @@ import VueVisibilityTrigger from 'vue-visibility-trigger'
3335
export default {
3436
...
3537
components: {
36-
"vue-visibility-trigger": VueVisibilityTrigger
38+
VueVisibilityTrigger
3739
}
3840
};
3941
</script>
4042
```
4143

42-
[![vue-visibility-trigger demo](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/qkyolorn6w?module=%2Fsrc%2FApp.vue)
44+
## Dev
45+
46+
Running dev and example scripts require @vue/cli and @vue/cli-service-global to be installed. Install globally by running `npm i --g @vue/cli @vue/cli-service-global` or `yarn add global vue/cli @vue/cli-service-global`

0 commit comments

Comments
 (0)