From a47cd3e1d53ae7580cb0647136760b0c39420aec Mon Sep 17 00:00:00 2001 From: Ou Date: Tue, 29 Oct 2024 18:31:28 +0800 Subject: [PATCH] chore: update readme --- README.md | 4 +++- README.zh-CN.md | 4 +++- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 829bd86..7ac28e3 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,9 @@ If login and caching are not required, you can directly deploy to platforms like For Cloudflare Pages, you need to set the build command to `pnpm run build` and the build output directory to `dist/output/public`. -For login, which involves GitHub OAuth, you only need to [create a GitHub App](https://github.com/settings/applications/new). No special permissions are required. After creating the app, you will get a Client ID and Client Secret. Different platforms have different places to set environment variables; refer to the `example.env.server` file. If running locally, rename it to `.env.server` and add the necessary values. +For login, which involves GitHub OAuth, you only need to [create a GitHub App](https://github.com/settings/applications/new). No special permissions are required. The callback URL should be `https://your-domain.com/api/oauth/github` (replace `your-domain` with your actual domain). + +After creating the app, you will get a Client ID and Client Secret. Different platforms have different places to set environment variables; refer to the `example.env.server` file. If running locally, rename it to `.env.server` and add the necessary values. ```env # Github Client ID diff --git a/README.zh-CN.md b/README.zh-CN.md index be1b957..5ebb211 100644 --- a/README.zh-CN.md +++ b/README.zh-CN.md @@ -14,7 +14,9 @@ Cloudflare Pages 需要填入构建命令 `pnpm run build`, 构建输出文件夹 `dist/output/public`。 -登录涉及到 Github Oauth，只需要 [创建一个 Github App](https://github.com/settings/applications/new) 即可，不需要申请任何权限。然后就会得到 Client ID 和 Client Secret。关于环境变量，不同平台有不同的填写位置，请关注 `example.env.server` 文件。如果本地运行，需要将其重命名为 `.env.server`，然后按照要求添加。 +登录涉及到 Github Oauth，只需要 [创建一个 Github App](https://github.com/settings/applications/new) 即可，不需要申请任何权限。Callback URL 为 `https://your-domain.com/api/oauth/github`。 + +然后就会得到 Client ID 和 Client Secret。关于环境变量，不同平台有不同的填写位置，请关注 `example.env.server` 文件。如果本地运行，需要将其重命名为 `.env.server`，然后按照要求添加。 ```env # Github Clien ID