doc: 更新 readme.md 文档

CHANGELOG.md

@@ -1,44 +0,0 @@
-# 变更日志
-
-本文件记录了本项目的所有重要变更。
-
-## [未发布]
-
-### ⚙️ 辅助工具的变动
-
-- 参数格式化(str 包)
-- Changelog file
-- Git-cliff generator changelog files
-- Console 包
-
-### 🐛 Bug 修复
-
-- Panic Recovery
-- Import package update
-
-### 📚 文档更新
-
-- Add README  文档
-
-### 🚀 新功能
-
-- 添加 make cmd  命令 \r\n例如: gohub make cmd testCommand
-- Play 命令,做调试使用
-- Key  命令
-- 命令行模式
-- Guest 中间件
-- 账号登陆
-- 手机+短信验证码登陆
-- Email+邮件验证码注册
-- 使用 Redis
-- 数据库请求日志
-- Panic Recovery
-- HTTP 访问日志
-- Email 是否已注册接口
-- 手机是否注册接口
-
-### 🚜 代码重构
-
-- Gofmt -l -w -s package
-
-<!-- 由 git-cliff 生成 -->

README.md

@@ -2,7 +2,7 @@
 
 Web 服务功能会封装到子命令 serve 中，命令行功能会封装到子命令 cli 中。
 
-除了 serve 命令，我们还会有以下命令：
+## 除了 serve 命令，我们还会有以下命令
 
 1. key 命令生成 app key
 2. make 命令
@@ -10,32 +10,48 @@ Web 服务功能会封装到子命令 serve 中，命令行功能会封装到子
 4. migrate 数据库迁移
 5. cache 缓存处理
 
-## commit 提交规范
+# 变更日志
 
-### 提交格式
+本文件记录了本项目的所有重要变更。
 
-```bash
-<type>: <subject>
-```
+## [未发布]
 
-### 提交类型
+### ⚙️ 辅助工具的变动
 
-- feat：新功能（feature）
-- fix：修补bug
-- docs：文档（documentation）
-- style： 格式（不影响代码运行的变动）
-- refactor：重构（即不是新增功能，也不是修改bug的代码变动）
-- test：增加测试
-- chore：构建过程或辅助工具的变动
+- 参数格式化(str 包)
+- Changelog file
+- Git-cliff generator changelog files
+- Console 包
 
-### 提交示例
+### 🐛 Bug 修复
 
-```bash
-feat: 添加用户注册功能
-fix: 修复用户登录 bug
-docs: 更新 README 文件
-style: 调整代码缩进
-refactor: 重构用户模块
-test: 添加用户模块测试
-chore: 更新依赖
-```
+- 删除测试的 testCommand
+- Panic Recovery
+- Import package update
+
+### 📚 文档更新
+
+- Add README  文档
+
+### 🚀 新功能
+
+- 添加 make cmd  命令 \r\n例如: gohub make cmd testCommand
+- Play 命令,做调试使用
+- Key  命令
+- 命令行模式
+- Guest 中间件
+- 账号登陆
+- 手机+短信验证码登陆
+- Email+邮件验证码注册
+- 使用 Redis
+- 数据库请求日志
+- Panic Recovery
+- HTTP 访问日志
+- Email 是否已注册接口
+- 手机是否注册接口
+
+### 🚜 代码重构
+
+- Gofmt -l -w -s package
+
+<!-- 由 git-cliff 生成 -->

cliff.toml

@@ -8,6 +8,18 @@
 [changelog]
 # 变更日志的标题模板
 header = """
+# GoHUB 项目主要提供的是 Web 服务, 且具备命令行功能
+
+Web 服务功能会封装到子命令 serve 中，命令行功能会封装到子命令 cli 中。
+
+## 除了 serve 命令，我们还会有以下命令
+
+  1. key 命令生成 app key
+  2. make 命令
+  3. seed 数据填充
+  4. migrate 数据库迁移
+  5. cache 缓存处理
+
 # 变更日志\n
 本文件记录了本项目的所有重要变更。\n
 """