chore: update readme & ci

pull/23/head
yugasun 3 years ago
parent 17ced673e4
commit 33f115036f

@ -9,6 +9,7 @@ on:
push:
branches:
- main
- master
- release/*
- feat/*
- fix/*

@ -23,10 +23,10 @@ A tool for decoding qrcode.
## Guide
Use `npm` to install.
Use `pnpm` to install.
```bash
$ npm install --save qrcode-decoder
$ pnpm install --save qrcode-decoder
```
Using in webpack:
@ -96,31 +96,31 @@ Stops the current `qr` from searching for a QRCode.
Install dependencies:
```bash
$ npm install
$ pnpm install
```
Build code:
```bash
$ npm run build
$ pnpm run build
```
Run unit test:
```bash
$ npm test
$ pnpm test
```
Modify version in `package.json`, run `release` script:
```bash
$ npm run release
$ pnpm run release
```
Publish
```bash
$ npm publish
$ pnpm publish
```
## License

@ -23,10 +23,10 @@
## 使用者指南
通过 npm 下载安装代码
通过 pnpm 下载安装代码
```bash
$ npm install --save qrcode-decoder
$ pnpm install --save qrcode-decoder
```
如果你是 webpack 等环境
@ -96,31 +96,31 @@ qr.decodeFromCamera(videoElem).then((res) => {
首次运行需要先安装依赖
```bash
$ npm install
$ pnpm install
```
一键打包生成生产代码
```bash
$ npm run build
$ pnpm run build
```
运行单元测试,浏览器环境需要手动测试,位于`test/browser`
```bash
$ npm test
$ pnpm test
```
修改 package.json 中的版本号,修改 README.md 中的版本号,修改 CHANGELOG.md然后发布新版
```bash
$ npm run release
$ pnpm run release
```
将新版本发布到 npm
将新版本发布到 pnpm
```bash
$ npm publish
$ pnpm publish
```
## License

@ -27,7 +27,7 @@
},
"lint-staged": {
"*.{ts,tsx,md}": [
"npm run prettier:fix",
"pnpm run prettier:fix",
"git add ."
]
},

Loading…
Cancel
Save