Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
@John60676
John60676 committed Jun 1, 2023
1 parent 3c9d74a commit 1a0d64a
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 32 deletions.
28 changes: 12 additions & 16 deletions README-zh_CN.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,36 +12,32 @@
<h1 align="center">VueRequest</h1>
<div align="center">
<p align="center">⚡️ 一个能轻松帮你管理请求状态（支持SWR，轮询，错误重试，缓存，分页等）的 Vue composition API 请求库</p>
<a href="https://codecov.io/github/attojs/vue-request?branch=master">
<a href="https://codecov.io/github/attojs/vue-request?branch=next">
<img
src="https://img.shields.io/codecov/c/github/attojs/vue-request?token=NW2XVQWGPP"
alt="Coverage Status"
/>
</a>
<a href="https://www.npmjs.com/package/vue-request/v/next">
<img src="https://img.shields.io/bundlephobia/minzip/vue-request/next" alt="Size" />
<a href="https://www.npmjs.com/package/vue-request">
<img src="https://img.shields.io/bundlephobia/minzip/vue-request" alt="Size" />
</a>
<a href="https://www.npmjs.com/package/vue-request/v/next">
<img src="https://img.shields.io/npm/v/vue-request/next" alt="Version" />
<a href="https://www.npmjs.com/package/vue-request">
<img src="https://img.shields.io/npm/v/vue-request" alt="Version" />
</a>
<a href="https://www.npmjs.com/package/vue-request/v/next">
<a href="https://www.npmjs.com/package/vue-request">
<img src="https://img.shields.io/github/languages/top/attojs/vue-request" alt="Languages" />
</a>
<a href="https://www.npmjs.com/package/vue-request/v/next">
<a href="https://www.npmjs.com/package/vue-request">
<img src="https://img.shields.io/npm/l/vue-request" alt="License" />
</a>
<a href="https://github.com/AttoJS/vue-request/stargazers">
<img src="https://img.shields.io/github/stars/attojs/vue-request" alt="Star" />
</a>
<a href="https://www.npmjs.com/package/vue-request/v/next">
<a href="https://www.npmjs.com/package/vue-request">
<img src="https://img.shields.io/npm/dm/vue-request" alt="Download" />
</a>
</div>

## 状态

目前处于 RC 版本，详情请查看[更新日志](https://github.com/AttoJS/vue-request/issues/121)。

## 为什么选择 VueRequest

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

```sh
npm install vue-request@next
npm install vue-request
# or
yarn add vue-request@next
yarn add vue-request
# or
pnpm install vue-request@next
pnpm install vue-request
```

### CDN

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

一旦你在页面中添加了它，你就可以在 `window.VueRequest` 中访问我们导出的方法。
Expand Down
28 changes: 12 additions & 16 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,36 +12,32 @@ English | [简体中文](README-zh_CN.md)
<h1 align="center">VueRequest</h1>
<div align="center">
<p align="center">⚡️ Vue composition API for data fetching, supports SWR, polling, error retry, cache request, pagination, etc.</p>
<a href="https://codecov.io/github/attojs/vue-request?branch=master">
<a href="https://codecov.io/github/attojs/vue-request?branch=next">
<img
src="https://img.shields.io/codecov/c/github/attojs/vue-request?token=NW2XVQWGPP"
alt="Coverage Status"
/>
</a>
<a href="https://www.npmjs.com/package/vue-request/v/next">
<img src="https://img.shields.io/bundlephobia/minzip/vue-request/next" alt="Size" />
<a href="https://www.npmjs.com/package/vue-request">
<img src="https://img.shields.io/bundlephobia/minzip/vue-request" alt="Size" />
</a>
<a href="https://www.npmjs.com/package/vue-request/v/next">
<img src="https://img.shields.io/npm/v/vue-request/next" alt="Version" />
<a href="https://www.npmjs.com/package/vue-request">
<img src="https://img.shields.io/npm/v/vue-request" alt="Version" />
</a>
<a href="https://www.npmjs.com/package/vue-request/v/next">
<a href="https://www.npmjs.com/package/vue-request">
<img src="https://img.shields.io/github/languages/top/attojs/vue-request" alt="Languages" />
</a>
<a href="https://www.npmjs.com/package/vue-request/v/next">
<a href="https://www.npmjs.com/package/vue-request">
<img src="https://img.shields.io/npm/l/vue-request" alt="License" />
</a>
<a href="https://github.com/AttoJS/vue-request/stargazers">
<img src="https://img.shields.io/github/stars/attojs/vue-request" alt="Star" />
</a>
<a href="https://www.npmjs.com/package/vue-request/v/next">
<a href="https://www.npmjs.com/package/vue-request">
<img src="https://img.shields.io/npm/dm/vue-request" alt="Download" />
</a>
</div>

## Status

Currently in RC version. For details, please see the [changelog](https://github.com/AttoJS/vue-request/issues/121).

## Why VueRequest

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.
Expand Down Expand Up @@ -74,19 +70,19 @@ You can install VueRequest with [NPM](https://www.npmjs.com/), [YARN](https://ya
### NPM

```sh
npm install vue-request@next
npm install vue-request
# or
yarn add vue-request@next
yarn add vue-request
# or
pnpm install vue-request@next
pnpm install vue-request
```

### CDN

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

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

0 comments on commit 1a0d64a

Please sign in to comment.