Skip to content

Commit 1a0d64a

Browse files
committed
docs: update readme
1 parent 3c9d74a commit 1a0d64a

File tree

2 files changed

+24
-32
lines changed

2 files changed

+24
-32
lines changed

Diff for: README-zh_CN.md

+12-16
Original file line numberDiff line numberDiff line change
@@ -12,36 +12,32 @@
1212
<h1 align="center">VueRequest</h1>
1313
<div align="center">
1414
<p align="center">⚡️ 一个能轻松帮你管理请求状态(支持SWR,轮询,错误重试,缓存,分页等)的 Vue composition API 请求库</p>
15-
<a href="https://codecov.io/github/attojs/vue-request?branch=master">
15+
<a href="https://codecov.io/github/attojs/vue-request?branch=next">
1616
<img
1717
src="https://img.shields.io/codecov/c/github/attojs/vue-request?token=NW2XVQWGPP"
1818
alt="Coverage Status"
1919
/>
2020
</a>
21-
<a href="https://www.npmjs.com/package/vue-request/v/next">
22-
<img src="https://img.shields.io/bundlephobia/minzip/vue-request/next" alt="Size" />
21+
<a href="https://www.npmjs.com/package/vue-request">
22+
<img src="https://img.shields.io/bundlephobia/minzip/vue-request" alt="Size" />
2323
</a>
24-
<a href="https://www.npmjs.com/package/vue-request/v/next">
25-
<img src="https://img.shields.io/npm/v/vue-request/next" alt="Version" />
24+
<a href="https://www.npmjs.com/package/vue-request">
25+
<img src="https://img.shields.io/npm/v/vue-request" alt="Version" />
2626
</a>
27-
<a href="https://www.npmjs.com/package/vue-request/v/next">
27+
<a href="https://www.npmjs.com/package/vue-request">
2828
<img src="https://img.shields.io/github/languages/top/attojs/vue-request" alt="Languages" />
2929
</a>
30-
<a href="https://www.npmjs.com/package/vue-request/v/next">
30+
<a href="https://www.npmjs.com/package/vue-request">
3131
<img src="https://img.shields.io/npm/l/vue-request" alt="License" />
3232
</a>
3333
<a href="https://github.com/AttoJS/vue-request/stargazers">
3434
<img src="https://img.shields.io/github/stars/attojs/vue-request" alt="Star" />
3535
</a>
36-
<a href="https://www.npmjs.com/package/vue-request/v/next">
36+
<a href="https://www.npmjs.com/package/vue-request">
3737
<img src="https://img.shields.io/npm/dm/vue-request" alt="Download" />
3838
</a>
3939
</div>
4040

41-
## 状态
42-
43-
目前处于 RC 版本,详情请查看[更新日志](https://github.com/AttoJS/vue-request/issues/121)
44-
4541
## 为什么选择 VueRequest
4642

4743
在以往的业务项目中,常常被 loading 状态的管理、请求的节流防抖、接口数据的缓存、分页等这些重复的实现所困惑。每当开启一个新项目时,我们都得手动去处理以上这些问题,这将是一个重复性的工作,而且还得确保团队的一致。
@@ -75,19 +71,19 @@ VueRequest 旨在为开发者提供便捷、快速的方式来管理接口的状
7571
### NPM
7672

7773
```sh
78-
npm install vue-request@next
74+
npm install vue-request
7975
# or
80-
yarn add vue-request@next
76+
yarn add vue-request
8177
# or
82-
pnpm install vue-request@next
78+
pnpm install vue-request
8379
```
8480

8581
### CDN
8682

8783
> 对于生产环境,我们推荐链接到一个明确的版本号和构建文件,以避免新版本造成的不可预期的破坏。
8884
8985
```html
90-
<script src="https://unpkg.com/vue-request@next/dist/vue-request.min.js"></script>
86+
<script src="https://unpkg.com/vue-request/dist/vue-request.min.js"></script>
9187
```
9288

9389
一旦你在页面中添加了它,你就可以在 `window.VueRequest` 中访问我们导出的方法。

Diff for: README.md

+12-16
Original file line numberDiff line numberDiff line change
@@ -12,36 +12,32 @@ English | [简体中文](README-zh_CN.md)
1212
<h1 align="center">VueRequest</h1>
1313
<div align="center">
1414
<p align="center">⚡️ Vue composition API for data fetching, supports SWR, polling, error retry, cache request, pagination, etc.</p>
15-
<a href="https://codecov.io/github/attojs/vue-request?branch=master">
15+
<a href="https://codecov.io/github/attojs/vue-request?branch=next">
1616
<img
1717
src="https://img.shields.io/codecov/c/github/attojs/vue-request?token=NW2XVQWGPP"
1818
alt="Coverage Status"
1919
/>
2020
</a>
21-
<a href="https://www.npmjs.com/package/vue-request/v/next">
22-
<img src="https://img.shields.io/bundlephobia/minzip/vue-request/next" alt="Size" />
21+
<a href="https://www.npmjs.com/package/vue-request">
22+
<img src="https://img.shields.io/bundlephobia/minzip/vue-request" alt="Size" />
2323
</a>
24-
<a href="https://www.npmjs.com/package/vue-request/v/next">
25-
<img src="https://img.shields.io/npm/v/vue-request/next" alt="Version" />
24+
<a href="https://www.npmjs.com/package/vue-request">
25+
<img src="https://img.shields.io/npm/v/vue-request" alt="Version" />
2626
</a>
27-
<a href="https://www.npmjs.com/package/vue-request/v/next">
27+
<a href="https://www.npmjs.com/package/vue-request">
2828
<img src="https://img.shields.io/github/languages/top/attojs/vue-request" alt="Languages" />
2929
</a>
30-
<a href="https://www.npmjs.com/package/vue-request/v/next">
30+
<a href="https://www.npmjs.com/package/vue-request">
3131
<img src="https://img.shields.io/npm/l/vue-request" alt="License" />
3232
</a>
3333
<a href="https://github.com/AttoJS/vue-request/stargazers">
3434
<img src="https://img.shields.io/github/stars/attojs/vue-request" alt="Star" />
3535
</a>
36-
<a href="https://www.npmjs.com/package/vue-request/v/next">
36+
<a href="https://www.npmjs.com/package/vue-request">
3737
<img src="https://img.shields.io/npm/dm/vue-request" alt="Download" />
3838
</a>
3939
</div>
4040

41-
## Status
42-
43-
Currently in RC version. For details, please see the [changelog](https://github.com/AttoJS/vue-request/issues/121).
44-
4541
## Why VueRequest
4642

4743
In the past projects, they were often confused by repeated implementations such as the management of the loading state, the requested throttling and debounce, the caching of request data, and pagination. Whenever we start a new project, we have to manually deal with the above problems, which will be a repetitive work, but also to ensure that the team is consistent.
@@ -74,19 +70,19 @@ You can install VueRequest with [NPM](https://www.npmjs.com/), [YARN](https://ya
7470
### NPM
7571

7672
```sh
77-
npm install vue-request@next
73+
npm install vue-request
7874
# or
79-
yarn add vue-request@next
75+
yarn add vue-request
8076
# or
81-
pnpm install vue-request@next
77+
pnpm install vue-request
8278
```
8379

8480
### CDN
8581

8682
> For production, we recommend linking to a specific version number and build to avoid unexpected breakage from newer versions.
8783
8884
```html
89-
<script src="https://unpkg.com/vue-request@next/dist/vue-request.min.js"></script>
85+
<script src="https://unpkg.com/vue-request/dist/vue-request.min.js"></script>
9086
```
9187

9288
Once you've added this you will have access to the `window.VueRequest` object and its exports.

0 commit comments

Comments
 (0)