Skip to content

Commit

Permalink
docs: fix README
Browse files Browse the repository at this point in the history
  • Loading branch information
daybrush committed Aug 4, 2022
1 parent 9c49266 commit 1eedb60
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 2 deletions.
6 changes: 5 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,11 @@
"**/@types/karma-chai",
"**/@types/karma-chai/**",
"**/@types/mocha",
"**/@types/mocha/**"
"**/@types/mocha/**",
"**/@vue/*",
"**/@vue/*/**",
"**/vue",
"**/vue/**"
]
}
}
11 changes: 10 additions & 1 deletion packages/vue2-conveyer/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,17 @@

## ⚙️ Installation

If Vue is less than 2.7 version, install the composition-api together.

```bash
$ npm install @egjs/vue2-conveyer
$ npm install @vue/composition-api
```

For Vue 2.7 or higher, use [Vue 3's vue-conveyer](https://github.com/naver/egjs-conveyer/tree/main/packages/vue-conveyer).

```bash
$ npm install @egjs/vue-conveyer
```

## 🏃 Quick Start
Expand All @@ -46,7 +55,7 @@ $ npm install @egjs/vue2-conveyer
import Vue from "vue";
import VueCompositionAPI from '@vue/composition-api';

// @vue/composition-api is required to use vue2-conveyer.
// @vue/composition-api is required to use vue2-conveyer for
Vue.use(VueCompositionAPI);
```
```vue
Expand Down

0 comments on commit 1eedb60

Please sign in to comment.