modify readme

This commit is contained in:
TooonyChen committed 2024-10-08 20:39:23 +13:00
commit 361a94a981
2 files changed
+12 -6

No files matched your search

+5 -2
View File
@@ -125,9 +125,11 @@ If there is no code, clickable link, or this is an advertisement email, return:
4. Back to `Action` Page in your repository, find `Deploy Auth Inbox to Cloudflare Workers` and press `Run workflow` to deploy the worker. If you can't find the `Run workflow` button, you can trigger GitHub Actions automatically by making a small edit to the `readme.md` file in your repository.
5. After the deployment is successful, you can find the URL of your worker in the `Deploy Auth Inbox to Cloudflare Workers` workflow log.
5. After the deployment is successful, you can find the URL of your worker in the `Deploy Auth Inbox to Cloudflare Workers` workflow log.
6. Done! ✅ You can now visit the URL for your newly deployed Auth Inbox to check the email results.
6. Find the `delete all logs` button in the upper-right corner of the workflow logs page. Delete the logs to avoid data leakage.
7. Done! ✅ You can now visit the URL for your newly deployed Auth Inbox to check the email results.
2. **Install using command-line**
@@ -233,6 +235,7 @@ This project is licensed under the [MIT License](LICENSE).
## TODO 📝
- [x] **Github Pages Deployment**: Automatically deploy to Cloudflare Workers via Github Actions.
- [ ] **Multi-User Support**: Add functionality to manage multiple users for increased flexibility and broader usage.
- [ ] **Enhance Front-End Design**: Improve the UI/UX of the web interface for a more modern and user-friendly experience.
- [ ] **API**: Add API functionality.
+7 -4
View File
@@ -113,20 +113,22 @@ If there is no code, clickable link, or this is an advertisement email, return:
[![Deploy to Cloudflare Workers](https://deploy.workers.cloudflare.com/button)](https://deploy.workers.cloudflare.com/?url=https://github.com/TooonyChen/AuthInbox)
1. 点击上方按钮 fork 此仓库,或直接 fork 此仓库。**重要:请务必把你的仓库设置为私密!!**
1. 点击上方按钮 fork 此仓库,或直接 fork 此仓库。
2. 打开你 fork 的仓库,找到 `Actions` 页面,找到 `Deploy Auth Inbox to Cloudflare Workers`,并点击 `enable workflow` 激活 workflow。
3. 然后,在仓库页面中,导航到 `Settings` -> `Secrets and variables` -> `Actions` -> `Repository secrets`,并添加以下 secrets:
- `CLOUDFLARE_ACCOUNT_ID`: Cloudflare 账户 ID。
- `CLOUDFLARE_API_TOKEN`: Cloudflare API Token。
- `TOML`: 配置文件,参考 [带有注释的wrangler.toml](https://github.com/TooonyChen/AuthInbox/blob/main/wrangler.toml.example)。**添加至secrets时,请使用[不带注释的版本](https://github.com/TooonyChen/AuthInbox/blob/main/wrangler.toml.example.clear)来避免奇怪的报错。
- `TOML`: 配置文件,参考 [带有注释的wrangler.toml](https://github.com/TooonyChen/AuthInbox/blob/main/wrangler.toml.example)。**添加至secrets时,请使用[不带注释的版本](https://github.com/TooonyChen/AuthInbox/blob/main/wrangler.toml.example.clear)来避免奇怪的报错。**
4. 返回你仓库的 `Actions` 页面,找到 `Deploy Auth Inbox to Cloudflare Workers`,并按 `Run workflow` 来部署 worker。如果没找到 `Run workflow` 按钮,请你随便修改一下repo中的`readme.md`文件,让Github Actions自动运行。
5. 部署成功后,你可以在 `Deploy Auth Inbox to Cloudflare Workers` 的 workflow 日志中找到你的 worker URL。
6. 完成!✅ 请前往第三步:设置邮件转发。
6. 在 workflow 日志页面的右上角找到 `delete all logs` 来删除日志,删除它来避免数据外泄。
7. 完成!✅ 请前往第三步:设置邮件转发。
2. **使用 Wrangler 命令行部署到 Cloudflare Workers**
@@ -230,8 +232,9 @@ If there is no code, clickable link, or this is an advertisement email, return:
---
## TODO 📝
- [x] **Github Pages 部署**:通过 Github Actions 自动部署到 Cloudflare Workers。
- [ ] **多用户支持**:增加管理多用户的功能,以提高灵活性并扩展使用范围。
- [ ] **增强前端设计**:改进网页界面的UI/UX设计,使其更加现代化和用户友好。
- [ ] **API**: 添加API接口。