LukeParke/better-auth
1
0
Fork 0
mirror of https://github.com/LukeHagar/better-auth.git synced 2025-12-10 12:27:44 +00:00
Code Issues Packages Projects Releases Wiki Activity

chore: fix github capitalisation (#297)

Browse Source
This commit is contained in:
Daniel Roe
2024-10-22 23:48:15 +01:00
committed by GitHub
parent 9d3d52d5e8
commit c7be5615d7
10 changed files with 16 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
docs/content/docs/authentication/github.mdx
View File

@@ -1,12 +1,12 @@
---
title: Github
description: Github Provider
title: GitHub
description: GitHub Provider
---
<Steps>
<Step>
### Get your Github credentials
To use Github sign in, you need a client ID and client secret. You can get them from the [Github Developer Portal](https://github.com/settings/developers).
### Get your GitHub credentials
To use GitHub sign in, you need a client ID and client secret. You can get them from the [GitHub Developer Portal](https://github.com/settings/developers).
Make sure to set the redirect URL to `http://localhost:3000/api/auth/callback/github` for local development. For production, you should set it to the URL of your application. If you change the base path of the auth routes, you should update the redirect URL accordingly.
</Step>
@@ -29,8 +29,8 @@ description: Github Provider
```
</Step>
<Step>
### Signin with Github
To signin with Github, you can use the `signIn.social` function provided by the client. The `signIn` function takes an object with the following properties:
### Signin with GitHub
To signin with GitHub, you can use the `signIn.social` function provided by the client. The `signIn` function takes an object with the following properties:
- `provider`: The provider to use. It should be set to `github`.
```ts title="client.ts"

4
docs/content/docs/basic-usage.mdx
View File

@@ -6,7 +6,7 @@ description: Getting started with Better Auth
Better Auth provides built-in authentication support for:
- **Email and password**
- **Social provider (Google, Github, Apple, and more)**
- **Social provider (Google, GitHub, Apple, and more)**
<Callout>
You can extend authentication options using plugins, such as: Username-based login, Passkeys, Email magic links, and more.
@@ -128,7 +128,7 @@ const handleSignIn = async () => {
## Social Sign-On
Better Auth supports multiple social providers, including Google, Github, Apple, Discord, and more. To use a social provider, you need to configure the ones you need in the `socialProviders` option on your `auth` object.
Better Auth supports multiple social providers, including Google, GitHub, Apple, Discord, and more. To use a social provider, you need to configure the ones you need in the `socialProviders` option on your `auth` object.
```ts title="auth.ts"
import { betterAuth } from "better-auth"