doc for patreon provider (nextauthjs#190)

* doc for patreon provider * Update patreon.md Co-authored-by: Balázs Orbán <[email protected]>
mochi-sann · Jan 10, 2022 · 6445c48 · 6445c48
1 parent d51f3cb
commit 6445c48
Showing 1 changed file with 40 additions and 0 deletions.
diff --git a/docs/providers/patreon.md b/docs/providers/patreon.md
@@ -0,0 +1,40 @@
+---
+id: patreon
+title: Patreon
+---
+
+## Documentation
+
+https://docs.patreon.com/#apiv2-oauth
+
+## Configuration
+
+:::tip
+  Create a API v2 client on [Patreon Platform](https://www.patreon.com/portal/registration/register-clients)
+:::
+
+## Options
+
+The **Patreon Provider** comes with a set of default options:
+
+- [Patreon Provider options](https://github.com/nextauthjs/next-auth/blob/main/src/providers/patreon.ts)
+
+You can override any of the options to suit your own use case.
+
+## Example
+
+```js
+import PatreonProvider from "next-auth/providers/patreon";
+...
+providers: [
+    PatreonProvider({
+      clientId: process.env.PATREON_ID,
+      clientSecret: process.env.PATREON_SECRET,
+    }))
+]
+...
+```
+
+:::note
+Make sure you use the scopes defined in [ApiV2](https://docs.patreon.com/#scopes)
+:::