Skip to content

Commit 01a036f

Browse files
committed
docs: update CDN guide, resolve #161
1 parent 1878f00 commit 01a036f

File tree

1 file changed

+23
-8
lines changed

1 file changed

+23
-8
lines changed

README.md

Lines changed: 23 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,29 +9,44 @@ English | [中文](./README.zh-CN.md) · [**Composition API Docs**](https://comp
99

1010
## Installation
1111

12+
### NPM
13+
1214
```bash
1315
npm install @vue/composition-api
1416
# or
1517
yarn add @vue/composition-api
1618
```
1719

18-
**CDN**
20+
You must install `@vue/composition-api` via `Vue.use()` before you can use the [Composition API](https://composition-api.vuejs.org/) to compose your component.
21+
22+
```js
23+
import Vue from 'vue'
24+
import VueCompositionApi from '@vue/composition-api'
25+
26+
Vue.use(VueCompositionApi)
27+
```
28+
29+
```js
30+
// in components
31+
import { ref, reactive } from '@vue/composition-api'
32+
```
33+
34+
### CDN
1935

2036
```html
2137
<script src="https://unpkg.com/@vue/composition-api/dist/vue-composition-api.umd.js"></script>
2238
```
2339

2440
The package will be exposed to global variable `window.vueCompositionApi`
2541

26-
## Usage
27-
28-
You must install `@vue/composition-api` via `Vue.use()` before you can use the [Composition API](https://composition-api.vuejs.org/) to compose your component.
29-
3042
```js
31-
import Vue from 'vue'
32-
import VueCompositionApi from '@vue/composition-api'
43+
// install the plugin
44+
Vue.use(vueCompositionApi.default)
45+
```
3346

34-
Vue.use(VueCompositionApi)
47+
```js
48+
// use the APIs
49+
const { ref, reactive } = vueCompositionApi
3550
```
3651

3752

0 commit comments

Comments
 (0)