Skip to content

Commit ccf0905

Browse files
committed
chore: update README
1 parent 1fd48f5 commit ccf0905

File tree

3 files changed

+11
-9
lines changed

3 files changed

+11
-9
lines changed

Diff for: .github/workflows/nodejs.yml

+3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
name: Build & Test
22

33
on:
4+
push:
5+
branches:
6+
- master
47
pull_request:
58
branches:
69
- master

Diff for: README.md

+4-5
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
# Vue Composition API
22

3-
> [Composition API RFC](https://vue-composition-api-rfc.netlify.com/)
3+
Vue 2 plugin for **Composition API** in Vue 3.
44

55
[![npm](https://img.shields.io/npm/v/@vue/composition-api)](https://www.npmjs.com/package/@vue/composition-api)
6+
[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/vuejs/composition-api/Build%20&%20Test)](https://github.com/vuejs/composition-api/actions?query=workflow%3A%22Build+%26+Test%22)
67

7-
`@vue/composition-api` provides a way to use `Vue 3.0`'s **Composition api** in `Vue 2.x`.
8+
English | [**中文文档**](./README.zh-CN.md) / [**Composition API RFC**](https://composition-api.vuejs.org/)
89

9-
**Note: the primary goal of this package is to allow the community to experiment with the API and provide feedback before it's finalized. The implementation may contain minor inconsistencies with the RFC as the latter gets updated. We do not recommend using this package for production yet at this stage.**
1010

11-
[**中文文档**](./README.zh-CN.md)
11+
**Note: the primary goal of this package is to allow the community to experiment with the API and provide feedback before it's finalized. The implementation may contain minor inconsistencies with the RFC as the latter gets updated. We do not recommend using this package for production yet at this stage.**
1212

1313
---
1414

@@ -19,7 +19,6 @@
1919
- [TypeScript](#TypeScript)
2020
- [TSX](#tsx)
2121
- [Limitations](#Limitations)
22-
- [API](https://vue-composition-api-rfc.netlify.com/api.html)
2322
- [Changelog](https://github.com/vuejs/composition-api/blob/master/CHANGELOG.md)
2423

2524
# Installation

Diff for: README.zh-CN.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
11
# Vue Composition API
22

3-
> [Composition API RFC](https://vue-composition-api-rfc.netlify.com/)
3+
Vue 2 插件用于提供 Vue 3 中的 **组合式 API**.
44

55
[![npm](https://img.shields.io/npm/v/@vue/composition-api)](https://www.npmjs.com/package/@vue/composition-api)
6+
[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/vuejs/composition-api/Build%20&%20Test)](https://github.com/vuejs/composition-api/actions?query=workflow%3A%22Build+%26+Test%22)
67

7-
`@vue/composition-api` 使开发者们可以在 `Vue 2.x` 中使用 `Vue 3.0` 引入的**基于函数****逻辑复用机制**
8+
[**English**](./README.md) | 中文文档 / [**组合式 API RFC**](https://composition-api.vuejs.org/zh)
89

9-
[**English Version**](./README.md)
10+
**请注意:此插件的主要目的是让社区尝试新的API并在其最终确定之前提供反馈。随着RFC的更新,该实现可能包含与RFC有细微的不一致。现阶段,我们暂不建议将此插件用于生产环境。**
1011

1112
---
1213

@@ -17,7 +18,6 @@
1718
- [TypeScript](#TypeScript)
1819
- [TSX](#tsx)
1920
- [限制](#限制)
20-
- [API](https://vue-composition-api-rfc.netlify.com/api.html)
2121
- [更新日志](https://github.com/vuejs/composition-api/blob/master/CHANGELOG.md)
2222

2323
# 安装

0 commit comments

Comments
 (0)