diff --git a/README.md b/README.md index fb02202f..2273bdc4 100644 --- a/README.md +++ b/README.md @@ -9,13 +9,29 @@ English | [中文](./README.zh-CN.md) · [**Composition API Docs**](https://comp ## Installation +### NPM + ```bash npm install @vue/composition-api # or yarn add @vue/composition-api ``` -**CDN** +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. + +```js +import Vue from 'vue' +import VueCompositionApi from '@vue/composition-api' + +Vue.use(VueCompositionApi) +``` + +```js +// in components +import { ref, reactive } from '@vue/composition-api' +``` + +### CDN ```html @@ -23,15 +39,14 @@ yarn add @vue/composition-api The package will be exposed to global variable `window.vueCompositionApi` -## Usage - -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. - ```js -import Vue from 'vue' -import VueCompositionApi from '@vue/composition-api' +// install the plugin +Vue.use(vueCompositionApi.default) +``` -Vue.use(VueCompositionApi) +```js +// use the APIs +const { ref, reactive } = vueCompositionApi ```