feat: docs update and refersh deps

StringKe · Mar 15, 2024 · bd686d2 · bd686d2
1 parent bdede52
commit bd686d2
Show file tree

Hide file tree

Showing 5 changed files with 2,085 additions and 158 deletions.
diff --git a/README.md b/README.md
@@ -4,34 +4,40 @@
 
 # simple-qrbtf
 
-Most of the code in this project comes from [ciaochaos/qrbtf](https://github.com/ciaochaos/qrbtf). Compared with [ciaochaos/qrbtf](https://github.com/ciaochaos/qrbtf), it removes the framework limitation and supports the use of `node` and `browser` in environments.
+Most of the code in this project comes from [ciaochaos/qrbtf](https://github.com/ciaochaos/qrbtf). Compared
+with [ciaochaos/qrbtf](https://github.com/ciaochaos/qrbtf), it removes the framework limitation and supports the use
+of `node` and `browser` in environments.
 
 # preview
 
 | base                                                     | circle                                                     | dsj                                                     |
-| -------------------------------------------------------- | ---------------------------------------------------------- | ------------------------------------------------------- |
+|----------------------------------------------------------|------------------------------------------------------------|---------------------------------------------------------|
 | <img src="./assets/base.png" width="80px" height="80px"> | <img src="./assets/circle.png" width="80px" height="80px"> | <img src="./assets/dsj.png" width="80px" height="80px"> |
 
 | func                                                    | image                                                     | imagefill                                                     |
-| ------------------------------------------------------- | --------------------------------------------------------- | ------------------------------------------------------------- |
+|---------------------------------------------------------|-----------------------------------------------------------|---------------------------------------------------------------|
 | <img src="./assets/fun.png" width="80px" height="80px"> | <img src="./assets/image.png" width="80px" height="80px"> | <img src="./assets/imagefill.png" width="80px" height="80px"> |
 
 | line                                                     | rand-rect                                                    | solid(2.5D)                                               |
-| -------------------------------------------------------- | ------------------------------------------------------------ | --------------------------------------------------------- |
+|----------------------------------------------------------|--------------------------------------------------------------|-----------------------------------------------------------|
 | <img src="./assets/line.png" width="80px" height="80px"> | <img src="./assets/randrect.png" width="80px" height="80px"> | <img src="./assets/solid.png" width="80px" height="80px"> |
 
 # install
 
-`npm i simple-qrbtf`
-
-# full api document
-
-[https://stringke.github.io/simple-qrbtf/](https://stringke.github.io/simple-qrbtf/)
-
-this document is automatically updated, the old version cannot be viewed.
+```bash
+npm i simple-qrbtf
+```
+```bash
+yarn add simple-qrbtf
+```
+```bash
+pnpm add simple-qrbtf
+```
 
 # use
 
+additional parameters can be found in the typescript type definition
+
 es6
 
 ```javascript

diff --git a/README_CN.md b/README_CN.md
@@ -3,42 +3,57 @@
 </p>
 
 # simple-qrbtf
-此项目大部分代码来自 [ciaochaos/qrbtf](https://github.com/ciaochaos/qrbtf)， 仅去除框架支持可以在 `node` 或 `browser` 中使用。
+
+此项目大部分代码来自 [ciaochaos/qrbtf](https://github.com/ciaochaos/qrbtf)，仅去除框架支持可以在 `node` 或 `browser` 中使用。
 
 # 预览
 
 | base                                                     | circle                                                     | dsj                                                     |
-| -------------------------------------------------------- | ---------------------------------------------------------- | ------------------------------------------------------- |
+|----------------------------------------------------------|------------------------------------------------------------|---------------------------------------------------------|
 | <img src="./assets/base.png" width="80px" height="80px"> | <img src="./assets/circle.png" width="80px" height="80px"> | <img src="./assets/dsj.png" width="80px" height="80px"> |
 
 | func                                                    | image                                                     | imagefill                                                     |
-| ------------------------------------------------------- | --------------------------------------------------------- | ------------------------------------------------------------- |
+|---------------------------------------------------------|-----------------------------------------------------------|---------------------------------------------------------------|
 | <img src="./assets/fun.png" width="80px" height="80px"> | <img src="./assets/image.png" width="80px" height="80px"> | <img src="./assets/imagefill.png" width="80px" height="80px"> |
 
 | line                                                     | rand-rect                                                    | solid(2.5D)                                               |
-| -------------------------------------------------------- | ------------------------------------------------------------ | --------------------------------------------------------- |
+|----------------------------------------------------------|--------------------------------------------------------------|-----------------------------------------------------------|
 | <img src="./assets/line.png" width="80px" height="80px"> | <img src="./assets/randrect.png" width="80px" height="80px"> | <img src="./assets/solid.png" width="80px" height="80px"> |
 
-
 # 安装
-`npm i simple-qrbtf`
 
-# 完整 API 文档
-[https://stringke.github.io/simple-qrbtf/](https://stringke.github.io/simple-qrbtf/)  
+```bash
+npm i simple-qrbtf
+```
+
+```bash
+yarn add simple-qrbtf
+```
 
-此文档随发布版本更新，无法查看旧版本。
+```bash
+pnpm add simple-qrbtf
+```
 
 # 使用
+
+更多参数请检查 typescript 类型定义
+
 es6
+
 ```javascript  
 import SimpleQr from 'simple-qrbtf';
 
-console.log(SimpleQr.base());
+console.log(SimpleQr.base({
+    "content": "Hello, world!",
+}));
 ```
 
 node
+
 ```javascript
 const SimpleQr = require('simple-qrbtf');
 
-console.log(SimpleQr.base());
+console.log(SimpleQr.base({
+    "content": "Hello, world!",
+}));
 ```
diff --git a/package.json b/package.json
@@ -24,7 +24,9 @@
   },
   "scripts": {
     "dev": "vite",
-    "build": "DEBUG=\"vite-plugin-dts:bundle\" vite build"
+    "build": "DEBUG=\"vite-plugin-dts:bundle\" vite build",
+    "commit" : "git-cz",
+    "release": "standard-version"
   },
   "author": {
     "name": "StringKe",
@@ -40,9 +42,16 @@
   ],
   "devDependencies": {
     "@types/node": "^20.11.27",
+    "cz-conventional-changelog": "^3.3.0",
     "prettier": "^3.2.5",
+    "standard-version": "^9.5.0",
     "typescript": "5.3.3",
     "vite": "^5.1.6",
     "vite-plugin-dts": "^3.7.3"
+  },
+  "config": {
+    "commitizen": {
+      "path": "./node_modules/cz-conventional-changelog"
+    }
   }
 }