diff --git a/README.md b/README.md index c38b8de..7a28896 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,24 @@ # peerjail 一个用于qbittorrent的辅助工具,识别异常的peer并将其加入黑名单 + +--- + +## 开始使用 +### 安装依赖 +创建虚拟并激活环境(可选) +```bash +python -m venv venv +source venv/bin/activate +# ./venv/Scripts/activate.ps1 +``` + +### 安装peerjail +```bash +pip install -e . +``` + +### 启动peerjail +```bash +peerjail --host 127.0.0.1 --port 8080 --username admin --password adminadmin +```