update README.md for docker

README.md

@@ -1,4 +1,19 @@
-# NewWordSpider项目使用文档
+# NewWordSpider
+
+![GitHub stars](https://img.shields.io/github/stars/hiddenblue/NewWordSpider?style=social)
+![GitHub forks](https://img.shields.io/github/forks/hiddenblue/NewWordSpider?style=social)
+![GitHub watchers](https://img.shields.io/github/watchers/hiddenblue/NewWordSpider?style=social)
+![GitHub repo size](https://img.shields.io/github/repo-size/hiddenblue/NewWordSpider?)
+![GitHub last commit](https://img.shields.io/github/last-commit/hiddenblue/NewWordSpider?color=red)
+[![Hits](https://hits.seeyoufarm.com/api/count/incr/badge.svg?url=https%3A%2F%2Fgh.neting.cc%2Fhiddenblue%2FNewWordSpider&count_bg=%2379C83D&title_bg=%23555555&icon=&icon_color=%23E7E7E7&title=hits&edge_flat=false)](https://hits.seeyoufarm.com)
+[![GitHub Actions](https://github.com/hiddenblue/NewWordSpider/actions/workflows/docker-image.yml/badge.svg)](https://github.com/hiddenblue/NewWordSpider/actions/workflows/docker-image.yml)
+
+## 功能
+
+- 从指定的 API 获取新词。
+- 将新词添加到用户词典中。
+- 支持定时运行。
+
 
 ## 1. 项目概述
    本项目旨在通过爬取特定网站的内容，提取新词，并将其转换为**小鹤双拼**格式
@@ -46,25 +61,19 @@ Rime用户词库管理模块，负责读取、写入、追加和保存Rime用户
 PinyinTools.py
 拼音工具模块，负责将汉字转换为拼音，并将全拼转换为小鹤双拼。
 
-logger_config.py
-日志配置模块，负责配置日志系统，并提供自定义日志记录器。
-
 config.json
 配置文件，包含API URL、API Key、分词模式等配置项。
 
-README.md
-项目说明文档，包含项目概述、安装说明、使用说明等。
-
-app.log
-运行时自动生成的日志文件，记录程序运行时的日志信息。
-
-
 ## 4. 安装与配置
 ### 4.1 安装依赖
 在项目根目录下运行以下命令安装所需的依赖包：
 
 
 ```bash
+git clone https://github.com/hiddenblue/NewWordSpider.git
+
+cd NewWordSpider
+
 pip install -r requirements.txt
 ```
 建议使用conda等环境进行依赖管理。
@@ -74,11 +83,13 @@ pip install -r requirements.txt
 
 ```json
 {
-"API_URL": "https://api.deepseek.com/chat/completions",
-"API_KEY": "<DeepSeek API Key>",
-"SPLIT_WORDS_MODE": "deepseek",
-"USER_DICT_PATH": "./flypy_user.txt",
-"USER_DICT_DB_PATH": "./flypy_user.db"
+   "LLM_API_URL": "https://api.deepseek.com/chat/completions",
+   "LLM_API_KEY": "",
+   "USER_DICT_PATH": "./flypy_user.txt",
+   "USER_DICT_DB_PATH": "./flypy_user.db",
+   "SPLIT_WORDS_MODE": "deepseek",
+   "LOGGING_LEVEL": "INFO",
+   "run_interval": 86400
 }
 ```
 API_URL : DeepSeek API 的 URL。,当然你也可以用其他LLM的api
@@ -97,19 +108,47 @@ USER_DICT_DB_PATH : SQLite 数据库文件路径。
 ```bash
 python main.py
 ```
-### 4.4 日志记录
-项目会将运行时的日志信息记录到 app.log 文件中，并在控制台输出。日志信息包括函数名和模块名，方便调试和排查问题。
-
-### 4.5 分词模式
+### 4.4 分词模式
 项目支持两种分词模式：
 
 deepseek : 使用 DeepSeek API 进行分词。
 jieba : 使用 jieba 进行分词。
 分词模式在 config.json 文件中配置。
 
-### 4.6 数据库操作
-项目会将新词条保存到 SQLite 数据库中，并在初次运行时备份老用户词典的数据。数据库文件路径在 config.json 文件中配置。
+## 5. 使用 Docker
+
+1. 手动构建 Docker 镜像：
+
+```shell
+git clone https://github.com/hiddenblue/NewWordSpider.git
+cd NewWordSpider
+docker build -t newwordspider .
+docker run -d --name newwordspider newwordspider
+```
+
+2. 使用 Docker Compose
+
+确保config.json和Docker-compose.yml文件在同一目录下。
+
+```yaml
+services:
+  newwordspider:
+    image: newwordspider:latest
+    build:
+      context: .
+      dockerfile: Dockerfile
+    volumes:
+      - ./config.json:/app/config.json
+    environment:
+      - RUN_INTERVAL=86400
+    restart: unless-stopped
+```
+
+然后运行
+```shell
+docker-compose up -d 
+```
+
+
 
-### 4.7 词库文件操作
-项目会将新词条追加到 Rime 用户词库文件中，并在每次追加时添加日期注释。词库文件路径在 config.json 文件中配置。