chore: update readme

This commit is contained in:
Ou
2024-10-29 18:31:28 +08:00
parent 6cbce058cc
commit a47cd3e1d5
2 changed files with 6 additions and 2 deletions
+3 -1
View File
@@ -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