Skip to content

Commit 951650f

Browse files
committed
style: 🎨 readme
1 parent 7995235 commit 951650f

File tree

3 files changed

+31
-16
lines changed

3 files changed

+31
-16
lines changed

README.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -38,19 +38,24 @@ High-quality and reliable Vue3 Hooks library
3838

3939
## 📦 Install
4040

41+
```bash
42+
npm i vue-hooks-plus
4143
```
42-
$ npm i vue-hooks-plus
43-
# or
44-
$ yarn add vue-hooks-plus
44+
45+
### CDN
46+
47+
```html
48+
<script src="https://cdn.jsdelivr.net/npm/vue-hooks-plus/dist/js/index.iife.js"></script>
4549
```
4650

51+
It will be exposed to global as `VueHooks_Plus`
52+
4753
## 🤹‍♀️ Usage
4854

4955
```typescript
5056
import { useRequest } from 'vue-hooks-plus'
5157

5258
// or Introduced on demand
53-
5459
import useRequest from 'vue-hooks-plus/es/useRequest'
5560
```
5661

@@ -76,4 +81,4 @@ This project is heavily inspired by the following awesome projects.
7681

7782
## 📄 License
7883

79-
[MIT License](https://github.com/InhiblabCore/vue-hooks-plus/blob/master/LICENSE) © 2022-PRESENT [Yong Git](https://github.com/NelsonYong)
84+
[MIT License](https://github.com/InhiblabCore/vue-hooks-plus/blob/master/LICENSE) © 2022-PRESENT [Yong Git](

README.zh-CN.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -38,19 +38,24 @@
3838

3939
## 📦 安装
4040

41+
```bash
42+
npm i vue-hooks-plus
4143
```
42-
$ npm i vue-hooks-plus
43-
# or
44-
$ yarn add vue-hooks-plus
44+
45+
### CDN
46+
47+
```html
48+
<script src="https://cdn.jsdelivr.net/npm/vue-hooks-plus/dist/js/index.iife.js"></script>
4549
```
4650

51+
它会导出一个全局的变量 `VueHooks_Plus`
52+
4753
## 🤹‍♀️ 使用
4854

4955
```typescript
5056
import { useRequest } from 'vue-hooks-plus'
5157

5258
// or 按需引入
53-
5459
import useRequest from 'vue-hooks-plus/es/useRequest'
5560
```
5661

packages/hooks/README.md

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -32,25 +32,30 @@ High-quality and reliable Vue3 Hooks library
3232
- 🦾 Preferred useRequest, Powerful request middle tier
3333
- 🎪 Interactive demo, immersive
3434
- 🎯 Written in TypeScript with predictable static types
35-
- ⚡️ Support the on-demand load, and reduce the packing volume
36-
- 🤺 The drill field shows its skills
35+
- 🪄 Support the on-demand load, and reduce the packing volume
36+
- 🤺 Playground, there's ample scope for one's abilities
3737
- 🔐 Perfect test, safe and reliable
3838

3939
## 📦 Install
4040

41+
```bash
42+
npm i vue-hooks-plus
4143
```
42-
$ npm i vue-hooks-plus
43-
# or
44-
$ yarn add vue-hooks-plus
44+
45+
### CDN
46+
47+
```html
48+
<script src="https://cdn.jsdelivr.net/npm/vue-hooks-plus/dist/js/index.iife.js"></script>
4549
```
4650

51+
It will be exposed to global as `VueHooks_Plus`
52+
4753
## 🤹‍♀️ Usage
4854

4955
```typescript
5056
import { useRequest } from 'vue-hooks-plus'
5157

5258
// or Introduced on demand
53-
5459
import useRequest from 'vue-hooks-plus/es/useRequest'
5560
```
5661

@@ -76,4 +81,4 @@ This project is heavily inspired by the following awesome projects.
7681

7782
## 📄 License
7883

79-
[MIT License](https://github.com/InhiblabCore/vue-hooks-plus/blob/master/LICENSE) © 2022-PRESENT [Yong Git](https://github.com/NelsonYong)
84+
[MIT License](https://github.com/InhiblabCore/vue-hooks-plus/blob/master/LICENSE) © 2022-PRESENT [Yong Git](

0 commit comments

Comments
 (0)