From 5b8249060d631f16e968ca7e13d92d454fe6da16 Mon Sep 17 00:00:00 2001 From: krau <71133316+krau@users.noreply.github.com> Date: Fri, 19 Dec 2025 20:57:28 +0800 Subject: [PATCH] docs: update readme --- README.md | 96 ++++++++++++++-------------------------------------- README_zh.md | 90 ++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 115 insertions(+), 71 deletions(-) create mode 100644 README_zh.md diff --git a/README.md b/README.md index defb091..932eba8 100644 --- a/README.md +++ b/README.md @@ -2,9 +2,9 @@ # Save Any Bot -**简体中文** | [English](https://sabot.unv.app/en/) +**English** | [简体中文](./README_zh.md) -> **把 Telegram 上的文件转存到多种存储端.** +> **Save Any Telegram File to Anywhere 📂. Support restrict saving content and beyond telegram.** [![Release Date](https://img.shields.io/github/release-date/krau/saveany-bot?label=release)](https://github.com/krau/saveany-bot/releases) [![tag](https://img.shields.io/github/v/tag/krau/saveany-bot.svg)](https://github.com/krau/saveany-bot/releases) @@ -19,46 +19,46 @@ ## 🎯 Features -- 支持文档/视频/图片/贴纸…甚至还有 [Telegraph](https://telegra.ph/) -- 破解禁止保存的文件 -- 批量下载 -- 流式传输 -- 多用户使用 -- 基于存储规则的自动整理 -- 监听并自动转存指定聊天的消息, 支持过滤 -- 使用 js 编写解析器插件以转存任意网站的文件 -- 存储端支持: +- Support documents / videos / photos / stickers… and even [Telegraph](https://telegra.ph/) +- Bypass "restrict saving content" media +- Batch download +- Streaming transfer +- Multi-user support +- Auto organize files based on storage rules +- Watch specified chats and auto-save messages, with filters +- Write JS parser plugins to save files from almost any website +- Storage backends: - Alist - S3 - WebDAV - - 本地磁盘 - - Telegram (重传回指定聊天) + - Local filesystem + - Telegram (re-upload to specified chats) ## 📦 Quick Start -创建文件 `config.toml` 并填入以下内容: +Create a `config.toml` file with the following content: ```toml [telegram] -token = "" # 你的 Bot Token, 在 @BotFather 获取 +token = "" # Your bot token, obtained from @BotFather [telegram.proxy] -# 启用代理连接 telegram, 当前只支持 socks5 +# Enable proxy for Telegram, currently only SOCKS5 is supported enable = false url = "socks5://127.0.0.1:7890" [[storages]] -name = "本地磁盘" +name = "Local Disk" type = "local" enable = true base_path = "./downloads" [[users]] -id = 114514 # 你的 Telegram 账号 id +id = 114514 # Your Telegram account id storages = [] blacklist = true ``` -使用 Docker 运行 Save Any Bot: +Run Save Any Bot with Docker: ```bash docker run -d --name saveany-bot \ @@ -67,69 +67,23 @@ docker run -d --name saveany-bot \ ghcr.io/krau/saveany-bot:latest ``` -请 [**查看文档**](https://sabot.unv.app/) 以获取更多配置选项和使用方法. +Please [**read the docs**](https://sabot.unv.app/en/) for more configuration options and usage. ## Sponsors -本项目受到 [YxVM](https://yxvm.com/) 与 [NodeSupport](https://github.com/NodeSeekDev/NodeSupport) 的支持. +This project is supported by [YxVM](https://yxvm.com/) and [NodeSupport](https://github.com/NodeSeekDev/NodeSupport). -如果这个项目对你有帮助, 你可以考虑通过以下方式赞助我: +If this project is helpful to you, consider sponsoring me via: -- [爱发电](https://afdian.com/a/unvapp) +- [Afdian](https://afdian.com/a/unvapp) -## Contributors - - - - - - - - - - - - -
- - krau -
- Krau -
-
- - Silentely -
- Abner -
-
- - TG-Twilight -
- Simon Twilight -
-
- - ysicing -
- 缘生 -
-
- - AHCorn -
- 安和 -
-
- - -## Thanks +## Thanks To - [gotd](https://github.com/gotd/td) - [TG-FileStreamBot](https://github.com/EverythingSuckz/TG-FileStreamBot) - [gotgproto](https://github.com/celestix/gotgproto) - [tdl](https://github.com/iyear/tdl) -- All the dependencies +- All the dependencies, contributors, sponsors and users. ## Contact diff --git a/README_zh.md b/README_zh.md new file mode 100644 index 0000000..f067f27 --- /dev/null +++ b/README_zh.md @@ -0,0 +1,90 @@ +
+ +# Save Any Bot + +> **把 Telegram 上的文件转存到多种存储端** + +[![Release Date](https://img.shields.io/github/release-date/krau/saveany-bot?label=release)](https://github.com/krau/saveany-bot/releases) +[![tag](https://img.shields.io/github/v/tag/krau/saveany-bot.svg)](https://github.com/krau/saveany-bot/releases) +[![Build Status](https://img.shields.io/github/actions/workflow/status/krau/saveany-bot/build-release.yml)](https://github.com/krau/saveany-bot/actions/workflows/build-release.yml) +[![Stars](https://img.shields.io/github/stars/krau/saveany-bot?style=flat)](https://github.com/krau/saveany-bot/stargazers) +[![Downloads](https://img.shields.io/github/downloads/krau/saveany-bot/total)](https://github.com/krau/saveany-bot/releases) +[![Issues](https://img.shields.io/github/issues/krau/saveany-bot)](https://github.com/krau/saveany-bot/issues) +[![Pull Requests](https://img.shields.io/github/issues-pr/krau/saveany-bot?label=pr)](https://github.com/krau/saveany-bot/pulls) +[![License](https://img.shields.io/github/license/krau/saveany-bot)](./LICENSE) + +
+ +## 🎯 特性 + +- 支持文档/视频/图片/贴纸…甚至还有 [Telegraph](https://telegra.ph/) +- 破解禁止保存的文件 +- 批量下载 +- 流式传输 +- 多用户使用 +- 基于存储规则的自动整理 +- 监听并自动转存指定聊天的消息, 支持过滤 +- 使用 js 编写解析器插件以转存任意网站的文件 +- 存储端支持: + - Alist + - S3 + - WebDAV + - 本地磁盘 + - Telegram (重传回指定聊天) + +## 快速开始 + +创建文件 `config.toml` 并填入以下内容: + +```toml +[telegram] +token = "" # 你的 Bot Token, 在 @BotFather 获取 +[telegram.proxy] +# 启用代理连接 telegram, 当前只支持 socks5 +enable = false +url = "socks5://127.0.0.1:7890" + +[[storages]] +name = "本地磁盘" +type = "local" +enable = true +base_path = "./downloads" + +[[users]] +id = 114514 # 你的 Telegram 账号 id +storages = [] +blacklist = true +``` + +使用 Docker 运行 Save Any Bot: + +```bash +docker run -d --name saveany-bot \ + -v ./config.toml:/app/config.toml \ + -v ./downloads:/app/downloads \ + ghcr.io/krau/saveany-bot:latest +``` + +请 [**查看文档**](https://sabot.unv.app/) 以获取更多配置选项和使用方法. + +## 赞助 + +本项目受到 [YxVM](https://yxvm.com/) 与 [NodeSupport](https://github.com/NodeSeekDev/NodeSupport) 的支持. + +如果这个项目对你有帮助, 你可以考虑通过以下方式赞助我: + +- [爱发电](https://afdian.com/a/unvapp) + +## 鸣谢 + +- [gotd](https://github.com/gotd/td) +- [TG-FileStreamBot](https://github.com/EverythingSuckz/TG-FileStreamBot) +- [gotgproto](https://github.com/celestix/gotgproto) +- [tdl](https://github.com/iyear/tdl) +- All the dependencies, contributors, sponsors and users. + +## 社区和关于作者 + +- [![通知群组](https://img.shields.io/badge/ProjectSaveAny-Group-blue)](https://t.me/ProjectSaveAny) +- [![讨论区](https://img.shields.io/badge/Github-Discussion-white)](https://github.com/krau/saveany-bot/discussions) +- [![个人频道](https://img.shields.io/badge/Krau-PersonalChannel-cyan)](https://t.me/acherkrau) \ No newline at end of file