From ab374a870b84a3d922116bb636a8405c8e43da73 Mon Sep 17 00:00:00 2001
From: krau <71133316+krau@users.noreply.github.com>
Date: Wed, 19 Feb 2025 13:41:57 +0800
Subject: [PATCH] chore: update readme and add english version

Co-authored-by: AHCorn <42889600+AHCorn@users.noreply.github.com>
---
 README.md    |   8 ++--
 README_EN.md | 108 +++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 113 insertions(+), 3 deletions(-)
 create mode 100644 README_EN.md

diff --git a/README.md b/README.md
index ec11ebf..aa9544e 100644
--- a/README.md
+++ b/README.md
@@ -2,6 +2,8 @@
 
 # <img src="docs/logo.jpg" width="45" align="center"> Save Any Bot
 
+**简体中文** | [English](README_EN.md) 
+
 把 Telegram 的文件保存到各类存储端.
 
 > _就像 PikPak Bot 一样_
@@ -60,9 +62,9 @@ systemctl enable --now saveany-bot
 
 #### Docker Compose
 
-下载 [docker-compose.yml](https://github.com/krau/SaveAny-Bot/blob/main/docker-compose.yml) 文件, 并修改其中的配置.
+下载 [docker-compose.yml](https://github.com/krau/SaveAny-Bot/blob/main/docker-compose.yml) 文件, 在同目录下新建 `config.toml` 文件, 参考 [config.toml.example](https://github.com/krau/SaveAny-Bot/blob/main/config.example.toml) 编辑配置文件.
 
-运行:
+启动:
 
 ```bash
 docker compose up -d
@@ -94,7 +96,7 @@ docker restart saveany-bot
 
 ## 使用
 
-向 Bot 发送(转发)文件, 按照提示操作.
+向 Bot 发送(转发)文件, 或发送公开频道的消息链接, 按照提示操作.
 
 ---
 
diff --git a/README_EN.md b/README_EN.md
new file mode 100644
index 0000000..ca1ddbd
--- /dev/null
+++ b/README_EN.md
@@ -0,0 +1,108 @@
+<div align="center">
+
+# <img src="docs/logo.jpg" width="45" align="center"> Save Any Bot
+
+[简体中文](README.md) | **English**
+
+Save Telegram files to various storage endpoints.
+
+> _Just like PikPak Bot_
+
+</div>
+
+Demo Video:
+
+<div align="center">
+
+[SaveAny-Bot Demo Video.webm](https://github.com/user-attachments/assets/a0de2453-a4d1-4a12-81fb-9d84856dce09)
+
+</div>
+
+## Deployment
+
+### Deploy from Binary
+
+Download the binary file for your platform from the [Release](https://github.com/krau/SaveAny-Bot/releases) page.
+
+Create a `config.toml` file in the extracted directory, refer to [config.toml.example](https://github.com/krau/SaveAny-Bot/blob/main/config.example.toml) for configuration.
+
+Run:
+
+```bash
+chmod +x saveany-bot
+./saveany-bot
+```
+
+#### Add as systemd Service
+
+Create file `/etc/systemd/system/saveany-bot.service` and write the following content:
+
+```
+[Unit]
+Description=SaveAnyBot
+After=systemd-user-sessions.service
+
+[Service]
+Type=simple
+WorkingDirectory=/yourpath/
+ExecStart=/yourpath/saveany-bot
+Restart=on-failure
+
+[Install]
+WantedBy=multi-user.target
+```
+
+Enable auto-start and start the service:
+
+```bash
+systemctl enable --now saveany-bot
+```
+
+### Deploy with Docker
+
+#### Docker Compose
+
+Download [docker-compose.yml](https://github.com/krau/SaveAny-Bot/blob/main/docker-compose.yml) file and create a `config.toml` file in the same directory, refer to [config.toml.example](https://github.com/krau/SaveAny-Bot/blob/main/config.example.toml) for configuration.
+
+Run:
+
+```bash
+docker compose up -d
+```
+
+#### Docker
+
+```shell
+docker run -d --name saveany-bot \
+    -v /path/to/config.toml:/app/config.toml \
+    -v /path/to/downloads:/app/downloads \
+    ghcr.io/krau/saveany-bot:latest
+```
+
+## Update
+
+Use `upgrade` or `up` command to upgrade to the latest version:
+
+```bash
+./saveany-bot upgrade
+```
+
+If deployed with Docker, use the following commands to update:
+
+```bash
+docker pull ghcr.io/krau/saveany-bot:latest
+docker restart saveany-bot
+```
+
+## Usage
+
+Send (forward) files to the Bot and follow the prompts.
+
+---
+
+## Thanks
+
+- [gotd](https://github.com/gotd/td)
+- [TG-FileStreamBot](https://github.com/EverythingSuckz/TG-FileStreamBot)
+- [gotgproto](https://github.com/celestix/gotgproto)
+- All the dependencies
\ No newline at end of file