diff --git a/README.md b/README.md
index 439a9f247bfa8010e4416c2bb04d93178259d1d5..29cf2110b58f96d4357fb38d73fd0eb3438f40f9 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,71 @@
-# scriptstodo
-日常使用脚本
\ No newline at end of file
+# scriptstodo
+日常使用脚本
+
+## 项目介绍
+`scriptstodo` 是一个包含日常使用脚本的项目，涵盖了 Kafka 消息处理、Python 数据处理以及 Windows 批处理脚本等模块。
+
+## 目录结构
+- **kafka**：包含 Kafka 生产者与消费者的实现。
+- **python**：提供 Python 数据处理脚本。
+- **windows/bat**：包含 Windows 批处理脚本。
+
+## 模块说明
+
+### Kafka 模块
+#### `kafka/cunsumer.py` 与 `kafka/producer.py`
+这两个文件实现了 Kafka 的消费者与生产者模式，主要功能如下：
+- **Kafka_producer**：用于发送 JSON 格式的消息。
+  - `__init__`：初始化 Kafka 服务器地址、端口和主题。
+  - `sendjsondata`：发送 JSON 数据到 Kafka。
+- **Kafka_consumer**：用于消费 Kafka 中的数据。
+  - `__init__`：初始化 Kafka 服务器地址、端口、主题和消费者组。
+  - `consume_data`：消费 Kafka 中的数据。
+
+### Python 模块
+#### `python/unique_duplicate.py`
+该脚本用于处理 Excel 文件中的重复记录：
+- `get_duplicate_record_rows`：获取指定列范围内的重复记录。
+- `wirte_excel`：将重复记录写入 Excel 文件。
+
+### Windows 批处理模块
+#### `windows/bat/defrag.bat`
+磁盘碎片整理脚本，用于优化磁盘性能。
+
+#### `windows/bat/flush_icon.bat`
+图标缓存刷新脚本，用于解决 Windows 图标显示异常的问题。
+
+## 使用说明
+### Kafka 模块使用示例
+1. 初始化 Kafka 生产者：
+   ```python
+   producer = Kafka_producer("localhost", 9092, "test_topic")
+   ```
+2. 发送 JSON 数据：
+   ```python
+   producer.sendjsondata({"key": "value"})
+   ```
+3. 初始化 Kafka 消费者并消费数据：
+   ```python
+   consumer = Kafka_consumer("localhost", 9092, "test_topic", "group1")
+   consumer.consume_data()
+   ```
+
+### Python 模块使用示例
+1. 获取重复记录：
+   ```python
+   duplicates = get_duplicate_record_rows("data.xlsx")
+   ```
+2. 写入 Excel 文件：
+   ```python
+   wirte_excel(duplicates)
+   ```
+
+### Windows 批处理脚本使用说明
+1. **磁盘碎片整理**：运行 `defrag.bat` 脚本进行磁盘碎片整理。
+2. **图标缓存刷新**：运行 `flush_icon.bat` 脚本刷新图标缓存。
+
+## 贡献指南
+欢迎贡献更多实用脚本。请确保提交的代码符合项目风格，并提供必要的文档说明。
+
+## 许可证
+该项目遵循 MIT 许可证。详情请查看 [LICENSE](LICENSE) 文件。
\ No newline at end of file