From abc52b92498a68aafbebb16c9efb152bdeded27a Mon Sep 17 00:00:00 2001
From: dqy <1016751306@qq.com>
Date: Fri, 19 Apr 2024 09:18:56 +0800
Subject: [PATCH] =?UTF-8?q?docs:=20=E8=A1=A5=E5=85=85=E9=A1=B9=E7=9B=AE?=
 =?UTF-8?q?=E8=83=8C=E6=99=AF=E3=80=81=E5=BC=80=E5=8F=91=E7=9B=AE=E6=A0=87?=
 =?UTF-8?q?=E7=AD=89=E5=86=85=E5=AE=B9?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 README.md      | 41 +++++++++++++++++++++++++++++++++++++++++
 docs/README.md |  2 +-
 2 files changed, 42 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 63d5653..7507584 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,43 @@
 # BackDoorBuster
 
+## 项目背景
+
+随着网络安全威胁的增加，恶意软件和后门的检测成为了保护个人和组织数据安全的重要任务。后门通常被隐藏在合法软件中，给黑客提供远程控制目标系统的能力。本项目旨在开发一个工具，能够有效识别和评估潜在的后门风险。
+
+## 项目目的
+
+本项目的主要目的是开发一个自动化工具，用于检测和评估代码库中潜在的后门风险。通过搜索包含特定敏感操作（如直接调用 `shell`）的代码段，并对发现的结果进行评级，从而帮助安全团队识别和修复安全漏洞。
+
+## 项目开发目标
+
+- **敏感操作检测**: 使用正则表达式来搜索代码中可能指示后门的敏感操作，如命令行执行（例如 `bin/sh`）。
+- **风险评级系统**: 对检测到的敏感操作进行分类和风险评级，帮助用户理解每个发现的潜在威胁级别。
+- **简易的用户接口**: 提供一个简单的命令行接口，允许用户快速扫描项目并获取报告。
+- **报告生成**: 自动生成详细的检测报告，列出所有发现的敏感操作和对应的风险等级。
+- **持续更新与维护**: 随着新的后门技术和检测方法的出现，持续更新正则表达式库和评级标准。
+
+## 使用说明
+
+1. 安装依赖:
+
+   ```bash
+   pip install -r requirements.txt
+   ```
+
+2. 执行扫描:
+
+    ```bash
+    python scan.py <project_directory>
+    ```
+
+3. 查看报告:
+
+    报告将以文本形式输出在控制台，并可选择输出到指定文件。
+
+## 贡献指南
+
+欢迎安全研究人员和开发人员贡献代码，改进正则表达式和评级逻辑。请通过 pull requests 提交您的贡献。
+
+## 许可证
+
+本项目采用 `MIT` 许可证。详情请见 [LICENSE](./LICENSE) 文件。
diff --git a/docs/README.md b/docs/README.md
index be62d6e..5940208 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -14,7 +14,7 @@
 
 ## 设计思路
 
-初步的实现方案记录在 **[idea.md](./idea.md)** 文件中，实际采用的详细设计思路记录在 `design.md` 文件中。
+初步的实现方案记录在 **[idea.md](./idea.md)** 文件中，实际采用的详细设计思路记录在 **[design.md](./design.md)** 文件中。
 
 ## 技术文档