Update readme.md

This commit is contained in:
路人甲 2023-10-27 20:44:32 +08:00 committed by GitHub
parent 3796594ae3
commit 57af1ba3c0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -10,21 +10,27 @@
## 一、下载 & 安装
该 Javascript 库 / 模块可以用于前端也可以用于后端 Nodejs 中。
脚本库可以用于浏览器,也可以用于 Nodejs 环境中。
1. 直接下载dist/relationship.min.js然后使用 `<script>`标签引入,可以得到全局的方法 `relationship`.
2. 使用 npm 进行包管理,具体为:
1. 直接在页面中引入 `<script type="text/javascript" src="https://passer-by.com/relationship/dist/relationship.min.js">`
获取全局方法 `relationship`
2. 使用 npm 安装名为 `relationship.js ` 的包
> **npm install relationship.js**
然后使用 `require` 引入模块
![npm](https://img.shields.io/npm/v/relationship.js) ![npm](https://img.shields.io/npm/dw/relationship.js)
在相应页面中引入模块
```js
var relationship = require("relationship.js");
// CommonJS 引入
const relationship = require("relationship.js");
```
```js
// ES Module 引入
import relationship from 'relationship.js';
```
![npm](https://img.shields.io/npm/v/relationship.js) ![npm](https://img.shields.io/npm/dw/relationship.js)
## 二、使用
1. 通用方法: 唯一的计算方法 `relationship`.