From 49c71039a4c0b727e9c9e613938810eee452d229 Mon Sep 17 00:00:00 2001 From: shuaiplus <2327005759@qq.com> Date: Sat, 7 Mar 2026 04:01:48 +0800 Subject: [PATCH] docs: update README and README_EN with clearer instructions for repository setup and synchronization --- README.md | 7 +++---- README_EN.md | 10 +++++----- 2 files changed, 8 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 3c80ec8..57c5f4a 100644 --- a/README.md +++ b/README.md @@ -77,7 +77,7 @@ English:[`README_EN.md`](./README_EN.md) > >1. 先 Fork 本仓库,并命名为 **NodeWarden**(默认自动填写) >2. 进入新仓库,进入 `Actions` 页面,点击 `I understand my workflows, go ahead and enable them`,点击 `Switch to KV mode`,点击`Run Workflow` ->3. 成功后**在你自己的仓库中**点击下面的按钮,在打开的页面中将项目名称改为 **NodeWarden2**,并将 **JWT_SECRET** 设置为 32 位随机字符串。 +>3. 成功后**在你自己的仓库中**点击下面的按钮,在打开的页面中将项目名称改为 **NodeWarden2**,并将 **JWT_SECRET** 设置为 32 位随机字符串。(不能选`创建专用 Git 存储库`) > > [![Deploy (R2)](https://deploy.workers.cloudflare.com/button)](https://deploy.workers.cloudflare.com/?url=https://github.com/shuaiplus/NodeWarden) > @@ -90,9 +90,8 @@ English:[`README_EN.md`](./README_EN.md) > [!TIP] > 同步方法(更新仓库): ->- 手动:打开你 Fork 的 GitHub 仓库,看到顶部同步提示后,点击 `Sync fork`。(不要点Contribute) ->- 自动:进入你的 Fork 仓库 -> `Actions`,点击 `I understand my workflows, go ahead and enable them`,启用后,`Sync upstream` 会在每天凌晨 3 点自动同步上游 `main`,并保留你当前的 [wrangler.toml](./wrangler.toml) 配置不被覆盖。 - +>- 手动:打开你 Fork 的 GitHub 仓库,看到顶部同步提示后,点击 `Sync fork`,点击`Update branch` +>- 自动:进入你的 Fork 仓库 -> `Actions`->`Sync upstream`->`Enable workflow`,会在每天凌晨 3 点自动同步上游。 ### CLI 部署 diff --git a/README_EN.md b/README_EN.md index aee0dd8..6cc2475 100644 --- a/README_EN.md +++ b/README_EN.md @@ -74,12 +74,12 @@ >- **KV**: no card required; **single attachment / Send file limit is 25 MiB** (Cloudflare limit, not editable); **1 GB free storage** > >1. Fork this repository and name it **NodeWarden**. ->2. Open your new repository, go to `Actions`, click `I understand my workflows, go ahead and enable them`, then run `Switch to KV mode`. ->3. After that, **in your own repository**, click the button below. On the page that opens, rename the project to **NodeWarden2** and set **JWT_SECRET** to a random 32-character string. +>2. Open the new repository, go to `Actions`, click `I understand my workflows, go ahead and enable them`, then run `Switch to KV mode`. +>3. After that, **in your own repository**, click the button below. On the page that opens, rename the project to **NodeWarden2** and set **JWT_SECRET** to a random 32-character string. Do not select `Create dedicated Git repository`. > > [![Deploy](https://deploy.workers.cloudflare.com/button)](https://deploy.workers.cloudflare.com/?url=https://github.com/shuaiplus/NodeWarden) > ->4. On the same page, open the Worker settings and disconnect the `Git repository`. +>4. On the same page, open Worker settings and disconnect the `Git repository`. >5. Go back to your forked repository (**NodeWarden**) on GitHub, open `Actions`, and run `Import KV ID from NodeWarden2`. >6. Return to Cloudflare, reconnect the `Git repository` to your forked repository (**NodeWarden**), and change the `Name` field at the bottom back to **NodeWarden**. >7. The GitHub repository **NodeWarden2** can then be deleted. @@ -87,8 +87,8 @@ > [!TIP] > Sync upstream (keep your fork updated): ->- Manual: open your fork on GitHub and click `Sync fork` when prompted. Do not click `Contribute`. ->- Automatic: in your fork, go to `Actions`, click `I understand my workflows, go ahead and enable them`. Once enabled, `Sync upstream` will automatically sync the upstream `main` branch every day at 3 AM and keep your current [wrangler.toml](./wrangler.toml) configuration unchanged. +>- Manual: open your fork on GitHub, click `Sync fork`, then click `Update branch`. +>- Automatic: in your fork, go to `Actions` -> `Sync upstream` -> `Enable workflow`. It will automatically sync from upstream every day at 3 AM. ### CLI deploy