Merge 701898f76c054deee64db3cd39e1e6a2a204d057 into 8feb565f59b85eac7072949d290cc6ae3b3a0d93

README.md

@@ -1,136 +1,233 @@
-# autoCommit
+<div align="center"><a name="readme-top"></a>
 
-<a href="https://github.com/OBKoro1/koro1FileHeader">
+![][image-banner]
-    <img alt="autoCommit Repo stars" src="https://img.shields.io/github/stars/OBKoro1/autoCommit">
-</a>
-<a href="https://github.com/OBKoro1/autoCommit/wiki/%E9%85%8D%E7%BD%AE%E5%8F%8A%E4%BD%BF%E7%94%A8%E8%AF%B4%E6%98%8E">
-    <img alt="wiki文档详细" src="https://img.shields.io/badge/wiki文档-齐全详细-blue">
-</a>
-<a href="https://github.com/OBKoro1/autoCommit/releases">
-    <img alt="持续维护" src="https://img.shields.io/badge/2020年开源-持续维护-blue">
-    <img alt="cicd" src="https://img.shields.io/badge/版本打包-release-blue">
-</a>
-<a href="https://github.com/OBKoro1/autoCommit/blob/master/LICENSE">
-    <img alt="开源协议-MIT" src="https://img.shields.io/badge/license-MIT-blue">
-</a>
 
-### 项目介绍
+# Auto Commit
 
-- 这是一个可以在任意时间范围自动提交 commit 的 VSCode 插件
+一款专为 Visual Studio Code 开发的自动化提交工具。本插件支持在任意指定的时间范围内进行 Git commit 操作，能够灵活设置每日提交频率，并通过随机化提交次数使提交记录更显真实自然。无需常驻运行，仅需在必要时花费数分钟即可一键填充 GitHub 个人主页的活跃度图表。
-- 它可以自由控制每天的 commit 次数, 随机 commit 次数，使你的 commit 提交看起来更加逼真。
-- **它在平常不用运行，需要的时候花十几分钟一键刷 commit，填满你的 github 首页绿色格子**。
 
-### 使用效果
+**简体中文** · [繁体中文](./README.zh-TW.md) · [Changelog][release-link] · [Documents][wiki-setup-link] · [Feedback][github-issues-link] · [BugReport][github-issues-link]
+
+<!-- SHIELD GROUP -->
+
+[![][github-star-shield]][github-star-link]
+[![][wiki-shield]][wiki-setup-link]
+[![][release-maintenance-shield]][release-link]
+[![][release-version-shield]][release-link]
+[![][license-shield]][license-link]
+
+</div>
+
+<details>
+<summary><kbd>📖 内容目录</kbd></summary>
+
+#### 
+
+- [✨ 使用效果](#-使用效果)
+- [⚡️ 功能特性](#️-功能特性)
+    - [快速便捷](#快速便捷)
+    - [灵活控制](#灵活控制)
+    - [安全保障](#安全保障)
+    - [高效执行](#高效执行)
+- [🛠️ 提交功能测试](#️-提交功能测试)
+- [👋🏻 快速开始](#-快速开始)
+    - [安装插件](#安装插件)
+    - [插件入口](#插件入口)
+    - [自动 commit 演示](#自动-commit-演示)
+- [🔗 其他开源推荐](#-其他开源推荐)
+    - [`1` koroFileHeader](#1-korofileheader)
+    - [`2` stop-mess-around](#2-stop-mess-around)
+    - [`3` web-basics](#3-web-basics)
+- [❤️ 赞助](#️-赞助)
+- [✉️ 联系我](#️-联系我)
+
+####
+
+<br/>
+
+</details>
+
+## ✨ 使用效果
 
 1. 使用本插件来控制 commit 次数.
 2. 如下图，你甚至可以规划一下`commit`次数，然后画出图形, 天空才是你的极限。
 
-![image](https://github.com/OBKoro1/autoCommit/blob/master/images/commit_img.png?raw=true)
+![image-demo-packman]
 
-#### 自动 commit 演示：
 
-![image](https://github.com/OBKoro1/autoCommit/blob/master/images/autoCommit.gif?raw=true)
+## ⚡️ 功能特性
 
-### 功能特性
+### 快速便捷
+- 一键快速提交：设置参数后即可快速执行批量 commit
+- 后台运行：不影响其他工作（如编码、浏览网页等）
+- 配置自动保存：成功运行后自动保存参数，免去重复设置
 
-- **一键提交**: 设置好参数之后，一键超快提交`commit`
+### 灵活控制
-- **选择多个日期范围**：一次操作即可提交不同日期`commit`, **还可以提交过去/未来日期的 commit**。
+- 多时间范围选择：支持在单次操作中提交不同日期的 commit，包括过去和未来日期
-- **控制每个日期的 commit 次数**: 可以用它来控制绿色格子的颜色，了解[commit 次数与颜色](https://github.com/OBKoro1/autoCommit/wiki/GitHub%E8%AE%BE%E7%BD%AE%E7%A7%81%E6%9C%89%E9%A1%B9%E7%9B%AE%E5%88%B7commit%E4%BB%A5%E5%8F%8Acommit%E7%9A%84%E6%AC%A1%E6%95%B0%E4%B8%8E%E9%A2%9C%E8%89%B2#commit%E6%AC%A1%E6%95%B0%E4%B8%8E%E9%A2%9C%E8%89%B2)
+- 提交频率自定义：可控制每个日期的 commit 次数，实现不同深浅的活跃度展示
-- **随机 commit 次数**：随机 commit 次数让我们的提交看起来更加逼真。
+- 随机化提交：
-- **间隔提交 commit**: 在一定的时间长度内，随机选取几天不提交 commit
+  - 支持随机 commit 次数，使提交记录更自然
-- 取消 commit: 用于在`commit`期间取消并回滚到未提交版本
+  - 可在指定时间范围内随机选择空档日，增加真实性
-- 超过 100 次提交，将强制考虑 10 秒是否要取消 commit。
-- 插件成功运行后，将自动保存配置参数，无须每次都要一通操作。
-- 提供完善的日志: 清晰的了解插件的运行情况
-- 后台运行，不影响编码、浏览网页等。
-- 运行超快，如下图 187 次 commit，20 秒搞定。
-- **觉得插件还不错的话，点个 Star 吧~**
 
-#### 提交以前和未来的 commit
+### 安全保障
+- 提交取消机制：支持在 commit 过程中取消并回滚到未提交版本
+- 安全提示：当提交次数超过 100 次时，强制等待 10 秒确认，防止误操作
+- 完善的日志系统：清晰记录插件运行状态，方便追踪
 
-在 19 年 12 月我创建了一个测试账号：[koroTest](https://github.com/koroTest)，经过测试：
+### 高效执行
+- 优异性能：例如 187 次 commit 仅需 20 秒完成
+- [了解更多：commit 次数与颜色的对应关系][wiki-color-and-commit-link]
 
-1. 成功提交 17 年的 10 月份的 commit。
+## 🛠️ 提交功能测试
-2. 现在 2020 年 1 月份，成功提交了 2020 年 2 月份的 commit。
-3. 具体能提交最早和最晚的日期没有测试过，有兴趣的可以试试~
 
-### 仓库地址:
+在[储存库][github-repo-link]使用[测试账号][github-profile-testing-link]测试的测试结果
 
-[autoCommit](https://github.com/OBKoro1/autoCommit)
+| 当日真实日期 | 尝试提交到日期 | 提交结果 |
+| --- | --- | --- |
+| 2019 年 12 月 | 2017 年 10 月 | ✅ |
+| 2020 年 1 月 | 2020 年 2 月 | ✅ |
 
-### 安装
+> \[!TIP]
+>
+> 这个工具能在所有时间范围做提交 Commit，几个月之前或之后都可以
 
-在 Vscode 扩展商店中搜索`Auto Commit`,点击安装即可。
+> \[!NOTE]
+> 
+> 具体能提交最早和最晚的日期没有测试过，有兴趣的可以试试~
+
+## 👋🏻 快速开始
+
+### 安装插件
+
+在 VSCode 的扩展商店中搜索 `auto commit` 安装  
+或点击 [[打开 Auto Commit 扩展页面]][vscode-marketplace-link] 安装 
 
 ### 插件入口
 
-1. 使用快捷键打开 VSCode 的命令面板。
+1. 打开 VSCode 的命令面板
-   - `mac`: `command + p` window: `ctrl + p`
-2. 输入`> auto commit 将会看到如下图所示的命令选项，然后用鼠标点击或者回车都可启动插件。
 
-   - 注意有`>`符号，老是用人不知道怎么用 o(╥﹏╥)o
+> \[!TIP]
-   - 实际上可以输入下方选项的任何一段文字，都可以匹配到插件命令选项。
+>  
+> 快捷键 mac: `command + p` window: `ctrl + p`
 
-![image](https://github.com/OBKoro1/autoCommit/blob/master/images/command.png?raw=true)
+2. 输入 `> auto commit` 将会看到如下图所示的命令选项
 
-### 文档
+<!-- // ![image-vscode-searchbar-1] -->
+![image-vscode-searchbar-2]
 
-- [配置及使用说明](https://github.com/OBKoro1/autoCommit/wiki/%E9%85%8D%E7%BD%AE%E5%8F%8A%E4%BD%BF%E7%94%A8%E8%AF%B4%E6%98%8E)
+> \[!INPORTANT]
-- [GitHub 设置私有项目刷 commit 以及 commit 的次数与颜色](https://github.com/OBKoro1/autoCommit/wiki/GitHub%E8%AE%BE%E7%BD%AE%E7%A7%81%E6%9C%89%E9%A1%B9%E7%9B%AE%E5%88%B7commit%E4%BB%A5%E5%8F%8Acommit%E7%9A%84%E6%AC%A1%E6%95%B0%E4%B8%8E%E9%A2%9C%E8%89%B2)
+>  
+> 注意要有`>`符号才能进入插件命令选项，否则就只会文件搜索而已。
 
-### 用爱发电，求赞助 😭
+3. 最后点击 `Auto Commit` 或是 `enter` 进入插件
 
-开源不易，本插件的开发与维护全都是利用业余时间。
+### 自动 commit 演示
 
-开源工作对我来说就是用爱发电，从 18 年开始在社区开源到现在，可以说基本没有收益。
+![image-demo-vscode]
 
-如果觉得这个效率工具还不错, 对你有所帮助，就赞助支持一下我的工作吧。
+> \[!CAUTION]
+>
+> 请注意，提交的 commit 会在 GitHub 上显示，所以请不要提交敏感信息
 
-<img src="https://raw.githubusercontent.com/OBKoro1/koro1FileHeader/dev/images/pay.jpg" alt="赞助" width="500px" style="display: block;"/>
+> \[!NOTE]
+>
+> 超详细的说明书：[文档][wiki-setup-link]，画图教学请看[这里][wiki-color-and-commit-link]
 
-### 插件声明
+## 🔗 其他开源推荐
 
-[autoCommit](https://github.com/OBKoro1/autoCommit)是本人兴之所至创建的个人项目，仅用于学习交流，禁止任何人商用以及用于非法之途。
+### `1` [koroFileHeader][suggest-koroFileHeader-link]
 
-插件如构成侵权，请通过邮件联系我。
+用于一键生成文件头部注释并自动更新最后编辑人和编辑时间、函数注释自动生成和参数提取。  
+插件支持所有主流语言,功能强大，配置灵活方便，文档齐全，食用简单！  
+插件从 2018 年 5 月维护至今, 3K+ Star，关闭 issue 300+
+目前拥有 250K+的用户，VSCode 图表统计日安装用户 100 多-400 多人，帮助用户养成良好的编码习惯，规范整个团队风格。
 
-### 其他开源推荐
+![头部注释][suggest-koroFileHeader-demo-1]  
 
-#### [koroFileHeader](https://github.com/OBKoro1/koro1FileHeader)
+![函数注释][suggest-koroFileHeader-demo-2]
 
-1. 它是用于一键生成文件头部注释并自动更新最后编辑人和编辑时间、函数注释自动生成和参数提取。
+### `2` [stop-mess-around][suggest-stopmessaround-link]
-2. 插件支持所有主流语言,功能强大，配置灵活方便，文档齐全，食用简单！
-3. 插件从 2018 年 5 月维护至今, 3K+ Star，关闭 issue 300+
-4. 目前拥有 250K+的用户，VSCode 图表统计日安装用户 100 多-400 多人，帮助用户养成良好的编码习惯，规范整个团队风格。
 
-![头部注释](https://raw.githubusercontent.com/OBKoro1/koro1FileHeader/master/images/example.gif)
+减少摸鱼的时间和频率的 Chrome 插件：
+在上班/学习期间很容易下意识的打开摸鱼网站，插件帮助我们减少摸鱼的时间和频率，提高我们上班和学习的效率，节省时间用于学习提升自己或者享受生活。
 
-![函数注释](https://github.com/OBKoro1/koro1FileHeader/raw/master/images/function-params.gif?raw=true)
+![suggest-stopmessaround-demo]
 
-#### [stop-mess-around](https://github.com/OBKoro1/stop-mess-around)
+### `3` [web-basics][suggest-webbasics-link]
 
-减少摸鱼的时间和频率的 Chrome 插件：**在上班/学习期间很容易下意识的打开摸鱼网站，插件帮助我们减少摸鱼的时间和频率，提高我们上班和学习的效率，节省时间用于学习提升自己或者享受生活**。
+收集和整理了一个大厂前端需要掌握能力的仓库，其中分为 JS 基础能力，大厂场景题、大厂面试真题。  
+希望能够帮助大家提升自己的能力，在面试的时候能够游刃有余，轻松拿到高薪 offer。  
 
-![](https://github.com/OBKoro1/stop-mess-around/blob/dev/static/example/run-introduction.gif?raw=true)
+![suggest-webbasics-source]
 
-### [web-basics](https://github.com/OBKoro1/web-basics)
+## ❤️ 赞助
 
-收集和整理了一个大厂前端需要掌握能力的仓库。
+开源不易，本插件的开发与维护全都是利用业余时间。  
+开源工作对我来说就是用爱发电，从 18 年开始在社区开源到现在，可以说基本没有收益。  
+如果觉得这个效率工具还不错, 对你有所帮助，就赞助支持一下我的工作并留个 Star 吧 ⭐️ ~
 
-其中分为 JS 基础能力，大厂场景题、大厂面试真题。
+![image-donate]
 
-希望能够帮助大家提升自己的能力，在面试的时候能够游刃有余，轻松拿到高薪 offer。
+## ✉️ 联系我
-
-![大厂前端需要掌握的能力](https://github.com/OBKoro1/web-basics/blob/main/static/web-basic-example.gif?raw=true)
-
-### License
-
-[MIT](http://opensource.org/licenses/MIT)
-
-### Star 一下吧
-
-如果插件觉得还不错的话，就给个 [Star](https://github.com/OBKoro1/autoCommit) ⭐️ 鼓励一下我吧~
-
-### 联系我
 
 [掘金](https://juejin.im/user/78820536236951)、[前端进阶积累](http://obkoro1.com/web_accumulate/)、[公众号](https://user-gold-cdn.xitu.io/2018/5/1/1631b6f52f7e7015?w=344&h=344&f=jpeg&s=8317)、[GitHub](https://github.com/OBKoro1)、[微信](https://raw.githubusercontent.com/OBKoro1/articleImg_src/master/weibo_img_move/005Y4rCogy1fsnslyz5pnj309j0cdgm6.jpg):OBkoro1、邮箱：obkoro1@foxmail.com
+
+<details><summary><h4>📝 许可证</h4></summary>
+
+Copyright 2020 [OBKoro1][github-profile-link]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+</details>
+
+Copyright © 2020 [OBKoro1][github-profile-link]. <br />
+
+<!-- LINK GROUP -->
+
+[github-profile-link]: https://github.com/OBKoro1  
+[github-profile-testing-link]: https://github.com/koroTest  
+[github-repo-link]: https://github.com/OBKoro1/autoCommit
+[github-issues-link]: https://github.com/OBKoro1/autoCommit/issues/new/choose  
+[github-star-shield]: https://img.shields.io/github/stars/OBKoro1/autoCommit  
+[github-star-link]: https://github.com/OBKoro1/koro1FileHeader  
+[license-shield]: https://img.shields.io/badge/license-MIT-blue  
+[license-link]: https://github.com/OBKoro1/autoCommit/blob/master/LICENSE  
+[release-version-shield]: https://img.shields.io/badge/版本打包-release-blue
+[release-maintenance-shield]: https://img.shields.io/badge/2020年开源-持续维护-blue  
+[release-link]: https://github.com/OBKoro1/autoCommit/releases  
+[suggest-koroFileHeader-link]: https://github.com/OBKoro1/koro1FileHeader  
+[suggest-koroFileHeader-demo-1]: https://raw.githubusercontent.com/OBKoro1/koro1FileHeader/master/images/example.gif  
+[suggest-koroFileHeader-demo-2]: https://raw.githubusercontent.com/OBKoro1/koro1FileHeader/master/images/function-params.gif
+[suggest-stopmessaround-link]: https://github.com/OBKoro1/stop-mess-around  
+[suggest-stopmessaround-demo]: https://github.com/OBKoro1/stop-mess-around/blob/dev/static/example/run-introduction.gif?raw=true
+[suggest-webbasics-link]: https://github.com/OBKoro1/web-basics  
+[suggest-webbasics-source]: https://github.com/OBKoro1/web-basics/blob/main/static/web-basic-example.gif?raw=true
+[vscode-marketplace-link]: vscode:extension/OBKoro1.autoCommit
+[wiki-shield]: https://img.shields.io/badge/wiki文档-齐全详细-blue  
+[wiki-setup-link]: https://github.com/OBKoro1/autoCommit/wiki/配置及使用说明  
+[wiki-color-and-commit-link]: https://github.com/OBKoro1/autoCommit/wiki/GitHub设置私有项目刷commit以及commit的次数与颜色  
+
+<!-- IMAGE GROUP -->
+
+[image-banner]: https://raw.githubusercontent.com/OBKoro1/autoCommit/refs/heads/master/images/banner.svg
+[image-demo-packman]: https://raw.githubusercontent.com/OBKoro1/autoCommit/refs/heads/master/images/commit_img.png
+[image-demo-vscode]: https://raw.githubusercontent.com/OBKoro1/autoCommit/refs/heads/master/images/autoCommit.gif
+[image-donate]: https://raw.githubusercontent.com/OBKoro1/koro1FileHeader/dev/images/pay.jpg
+<!-- //[image-vscode-searchbar-1]: https://raw.githubusercontent.com/OBKoro1/autoCommit/refs/heads/master/images/command.png -->
+[image-vscode-searchbar-2]: https://raw.githubusercontent.com/OBKoro1/autoCommit/refs/heads/master/videos/autocommit-activate.mp4
+
+<!-- DEV LINK GROUP, if add new image commit following in link group while editing this file -->
+
+<!-- [image-banner]: images/banner.svg -->
+<!-- [image-vscode-searchbar-2]: images/command-2.gif -->
+