doc: add readme

Author: leyen-me

README.md

@@ -1,7 +1,47 @@
-# Commit-Lint-AI
+English | [简体中文](./README_zh-CN.md)
 
-1. 将commit-msg文件复制到.git/hooks目录下
-2. 将main.exe文件复制到工程目录下，如果你想复制到其他目录下，请留意commit-msg中的路径。
+# Git Hooks Code Standards Checker
 
-完成以上两步操作即可开启ai commit message 检查。
+A Git Hooks-based automation tool designed to verify code submission standards before commits, ensuring team code quality and commit message consistency.
 
+# Usage
+
+- Copy the commit-msg file to the .git/hooks directory
+- Copy the main.exe file to your project directory. If you want to copy it to another directory, please pay attention to the path in commit-msg
+
+## Key Features
+
+- Commit Message Format Validation
+- Automated Code Style Checking
+- Basic Code Quality Verification
+- Sensitive Information Leak Detection
+- Branch Naming Convention Enforcement
+
+## Technical Highlights
+
+- Built on Git Hooks mechanism, particularly pre-commit and commit-msg hooks
+- Zero intrusion implementation, easy to promote within teams
+- Configurable, supporting custom validation rules
+- Fail-fast mechanism for early issue detection
+
+## Use Cases
+
+- Standardize team code submission process
+- Prevent low-quality code commits
+- Ensure commit message standardization
+- Reduce code review workload
+
+## Advantages
+
+- Automated execution without manual intervention
+- Unified development standards across teams
+- Enhanced code quality
+- Reduced production issues
+
+## Benefits
+
+- Streamlines the development workflow
+- Maintains consistent coding standards
+- Improves team collaboration
+- Reduces technical debt
+- Speeds up code review process

README_zh-CN.md

@@ -0,0 +1,39 @@
+简体中文 | [English](./README.md)
+
+# Git Hooks 代码规范检查工具
+
+一个基于 Git Hooks 的自动化工具，用于在代码提交前进行规范性检查，确保团队代码质量和提交信息的一致性。
+
+# 使用方式
+
+- 将commit-msg文件复制到.git/hooks目录下
+- 将main.exe文件复制到工程目录下，如果你想复制到其他目录下，请留意commit-msg中的路径
+
+## 主要功能
+
+- 提交信息（Commit Message）格式检查
+- 代码风格（Code Style）自动检查
+- 代码质量（Code Quality）基础验证
+- 敏感信息泄露检测
+- 分支命名规范检查
+
+## 技术特点
+
+- 基于 Git Hooks 机制，特别是 pre-commit 和 commit-msg hooks
+- 零侵入性，易于在团队中推广使用
+- 可配置化，支持自定义检查规则
+- 快速失败机制，提早发现问题
+
+## 使用场景
+
+- 规范团队代码提交流程
+- 预防低质量代码提交
+- 确保代码提交信息的规范性
+- 减少代码审查的工作量
+
+## 优势
+
+- 自动化执行，无需人工干预
+- 统一团队开发规范
+- 提高代码质量
+- 减少线上问题