Просмотр исходного кода

docs: 添加二次开发与引用说明

sansan 3 месяцев назад
Родитель
Сommit
13f0046a03
5 измененных файлов с 30 добавлено и 5 удалено
  1. 13 0
      README-EN.md
  2. 11 0
      README.md
  3. 4 3
      docker/.env
  4. 1 1
      docker/docker-compose-build.yml
  5. 1 1
      docker/docker-compose.yml

+ 13 - 0
README-EN.md

@@ -174,6 +174,19 @@ Any amount is welcome; even 1 RMB is a gesture of kindness.
 1. **Star the Repo** ⭐️: It only takes **1 second**. Letting more people see this project is the greatest recognition for me.
 2. **Charity** 🌻: Search for **Tencent Charity** (or support a local charity) to help students in need. Pass this kindness forward.
 
+### 🤝 Attribution & Secondary Development
+
+If you utilize the core code or draw inspiration from the logic of this project, **it would be greatly appreciated** if you could acknowledge the source in your README or documentation and include a link to this repository.
+
+> [https://github.com/sansan0/TrendRadar](https://github.com/sansan0/TrendRadar)
+
+This contributes to the sustainable maintenance of the project and the growth of the community. Thank you for your respect and support! ❤️
+
+**Reference Example** (e.g., my other project):
+
+> [https://github.com/sansan0/bilibili-comment-analyzer](https://github.com/sansan0/bilibili-comment-analyzer)
+
+
 ---
 
 ### 💬 Feedback & Community

+ 11 - 0
README.md

@@ -221,6 +221,17 @@ TrendRadar 是完全开源免费的项目,持续更新需要你的动力支持
 1. **点亮 Star** ⭐️:动动手指只需 **1 秒**,让更多人看到这个项目,这是对我最大的认可。
 2. **公益助学** 🌻:微信搜索**腾讯公益**,支持**助学**项目。将这份善意传递给需要的人。
 
+### 🤝 二次开发与引用
+
+如果你在项目中使用或借鉴了本项目的思路、核心代码,**非常欢迎**在 README 或文档中注明来源并附上本仓库链接。
+
+> [https://github.com/sansan0/TrendRadar](https://github.com/sansan0/TrendRadar)
+
+这将有助于项目的持续维护和社区发展,感谢你的尊重与支持!❤️
+
+**示范参考**(比如我的这个项目):
+> [https://github.com/sansan0/bilibili-comment-analyzer](https://github.com/sansan0/bilibili-comment-analyzer)
+
 ---
 
 ### 💬 交流与反馈

+ 4 - 3
docker/.env

@@ -37,7 +37,8 @@ EMAIL_SMTP_PORT=
 
 # ntfy 推送配置(多账号用 ; 分隔,topic 和 token 数量需一致)
 # ntfy 服务器地址(可改为自托管)
-NTFY_SERVER_URL=https://ntfy.sh
+# 留空则默认使用 https://ntfy.sh,如需自建请填写
+NTFY_SERVER_URL=
 # ntfy主题名称(多账号用 ; 分隔)
 NTFY_TOPIC=
 # 可选:访问令牌(用于私有主题,多账号用 ; 分隔,无令牌的留空占位如 ";token2")
@@ -61,12 +62,12 @@ GENERIC_WEBHOOK_TEMPLATE=
 # ============================================
 
 # 是否启用 AI 分析 (true/false)
-AI_ANALYSIS_ENABLED=false
+AI_ANALYSIS_ENABLED=
 # AI API Key(必填,启用 AI 功能时需要)
 AI_API_KEY=
 # 模型名称(LiteLLM 格式: provider/model_name)
 # 示例: deepseek/deepseek-chat, openai/gpt-4o, gemini/gemini-2.5-flash
-AI_MODEL=deepseek/deepseek-chat
+AI_MODEL=
 # 自定义 API 端点(可选,大多数情况留空)
 AI_API_BASE=
 

+ 1 - 1
docker/docker-compose-build.yml

@@ -43,7 +43,7 @@ services:
       - GENERIC_WEBHOOK_URL=${GENERIC_WEBHOOK_URL:-}
       - GENERIC_WEBHOOK_TEMPLATE=${GENERIC_WEBHOOK_TEMPLATE:-}
       # AI 配置(ai_analysis 和 ai_translation 共享模型配置)
-      - AI_ANALYSIS_ENABLED=${AI_ANALYSIS_ENABLED:-false}
+      - AI_ANALYSIS_ENABLED=${AI_ANALYSIS_ENABLED:-}
       - AI_API_KEY=${AI_API_KEY:-}
       - AI_MODEL=${AI_MODEL:-}
       - AI_API_BASE=${AI_API_BASE:-}

+ 1 - 1
docker/docker-compose.yml

@@ -41,7 +41,7 @@ services:
       - GENERIC_WEBHOOK_URL=${GENERIC_WEBHOOK_URL:-}
       - GENERIC_WEBHOOK_TEMPLATE=${GENERIC_WEBHOOK_TEMPLATE:-}
       # AI 配置(ai_analysis 和 ai_translation 共享模型配置)
-      - AI_ANALYSIS_ENABLED=${AI_ANALYSIS_ENABLED:-false}
+      - AI_ANALYSIS_ENABLED=${AI_ANALYSIS_ENABLED:-}
       - AI_API_KEY=${AI_API_KEY:-}
       - AI_MODEL=${AI_MODEL:-}
       - AI_API_BASE=${AI_API_BASE:-}