Skip to content

Commit

Permalink
chore(readme): up
Browse files Browse the repository at this point in the history
  • Loading branch information
Tahul committed Nov 13, 2023
1 parent 0542345 commit 66aa58e
Showing 1 changed file with 15 additions and 3 deletions.
18 changes: 15 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -321,16 +321,28 @@ You can totally rewrite any of these components locally to implement your own au

### OAuth

If you want to use OAuth, you will have to enable it in your `nuxt.config`:

```typescript
export default defineNuxtConfig({
edgeDb: {
oauth: true
}
})
```

That will inject two new components to your app:

- [`EdgeDbOAuthButton`](./src/runtime/components/EdgeDbOAuthButton.vue)
- [`EdgeDbOAuthCallback`](./src/runtime/components/EdgeDbOAuthCallback.vue)

EdgeDB currently supports [OAuth](https://www.edgedb.com/docs/guides/auth/oauth#oauth) on following providers:

- Apple
- Azure (Microsoft)
- GitHub
- Google

- [`EdgeDbOAuthButton`](./src/runtime/components/EdgeDbOAuthButton.vue)
- [`EdgeDbOAuthCallback`](./src/runtime/components/EdgeDbOAuthCallback.vue)

In order to get OAuth working, you will have to visit your EdgeDB Instance UI, via the Nuxt DevTools.

Browse to your database and visit "Auth Admin" tab.
Expand Down

0 comments on commit 66aa58e

Please sign in to comment.