From b68d3f705ca4e4a3c678443033cc54a70452070d Mon Sep 17 00:00:00 2001
From: gitee-bot <no-reply@git.oschina.net>
Date: Mon, 15 Sep 2025 11:55:59 +0000
Subject: [PATCH] Add README.md

---
 README.en.md | 60 ++++++++++++++++++++++++++++++++++++++++++++++++++++
 README.md    | 60 ++++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 120 insertions(+)
 create mode 100644 README.en.md
 create mode 100644 README.md

diff --git a/README.en.md b/README.en.md
new file mode 100644
index 0000000..d1dfe62
--- /dev/null
+++ b/README.en.md
@@ -0,0 +1,60 @@
+# WiFiPy
+
+An optimized WiFi password cracking tool that supports both dictionary attack and brute-force modes.
+
+## Features
+- Supports dictionary attacks and brute-force cracking
+- Configurable password length range and character set
+- Automatically saves cracking results to a file
+- Supports interruption and stopping functions
+- Displays cracking progress in real-time
+
+## Installation Requirements
+```bash
+pip install pywifi
+```
+
+## Usage Example
+```python
+# Initialize the cracker
+cracker = WiFiCracker(ssid="Target WiFi Name")
+
+# Load dictionary file (optional)
+dictionary = load_dictionary("passwords.txt")
+
+# Start cracking
+password = cracker.crack(
+    min_length=8,
+    max_length=10,
+    dictionary=dictionary
+)
+
+# Stop cracking (when manual interruption is needed)
+cracker.stop()
+```
+
+## API Documentation
+### WiFiCracker Class
+```python
+def __init__(self, ssid: str, max_threads: int = 3):
+    """
+    Initializes the password cracker
+    :param ssid: Name of the target WiFi
+    :param max_threads: Maximum number of threads
+    """
+
+def crack(self, min_length: int = 8, max_length: int = 10, 
+          charset: str = '0123456789abcdefghijklmnopqrstuvwxyz',
+          dictionary: Optional[List[str]] = None) -> Optional[str]:
+    """
+    Main cracking method
+    :param min_length: Minimum password length
+    :param max_length: Maximum password length
+    :param charset: Character set for password generation
+    :param dictionary: Optional list of dictionary passwords
+    :return: The found password or None
+    """
+```
+
+## License
+MIT License
\ No newline at end of file
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e0c5b7e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,60 @@
+# WiFiPy
+
+优化后的WiFi密码破解工具，支持字典攻击和暴力破解两种模式。
+
+## 功能特性
+- 支持字典攻击和暴力破解
+- 可配置密码长度范围和字符集
+- 自动保存破解结果到文件
+- 支持中断和停止功能
+- 实时显示破解进度
+
+## 安装依赖
+```bash
+pip install pywifi
+```
+
+## 使用示例
+```python
+# 初始化破解器
+cracker = WiFiCracker(ssid="目标WiFi名称")
+
+# 加载字典文件（可选）
+dictionary = load_dictionary("passwords.txt")
+
+# 开始破解
+password = cracker.crack(
+    min_length=8,
+    max_length=10,
+    dictionary=dictionary
+)
+
+# 停止破解（当需要手动中断时）
+cracker.stop()
+```
+
+## API文档
+### WiFiCracker类
+```python
+def __init__(self, ssid: str, max_threads: int = 3):
+    """
+    初始化破解器
+    :param ssid: 目标WiFi名称
+    :param max_threads: 最大线程数
+    """
+
+def crack(self, min_length: int = 8, max_length: int = 10, 
+          charset: str = '0123456789abcdefghijklmnopqrstuvwxyz',
+          dictionary: Optional[List[str]] = None) -> Optional[str]:
+    """
+    主破解方法
+    :param min_length: 最小密码长度
+    :param max_length: 最大密码长度
+    :param charset: 密码字符集
+    :param dictionary: 可选字典列表
+    :return: 找到的密码或None
+    """
+```
+
+## 许可证
+MIT License
\ No newline at end of file
-- 
Gitee