update docs

Author: WilsonLe

README.md

@@ -16,59 +16,22 @@
 - 🔐 Configures OAuth2 with any providers
 - ✨ Zero dependencies
 - ⚙ Highly customizable
+-
+
+# Integrations
+
+Technically this plugin should work with all generic OAuth2 providers. However, here are the list of providers that have been tested:
+
+| Provider | Status                                                                                                                                                                                                   | Example                        |
+| -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------ |
+| Google   | [![Test Google OAuth](https://github.com/WilsonLe/payload-oauth2/actions/workflows/test-google-oauth.yml/badge.svg)](https://github.com/WilsonLe/payload-oauth2/actions/workflows/test-google-oauth.yml) | [Config](./examples/google.md) |
 
 # Installation
 
 ```
 npm install payload-oauth2
 yarn install payload-oauth2
-```
-
-# Example Usage
-
-Integrating Google OAuth2 to `users` collection.
-
-```ts
-export default buildConfig({
-  // ...
-  admin: {
-    importMap: { baseDir: path.resolve(dirname) },
-    components: {
-      // A simple button with <a> tag that links to your authorization path
-      // which defaults to /api/users/oauth/authorize
-      afterLogin: ["app/components/OAuthLoginButton#OAuthLoginButton"],
-    },
-    user: "users", // assuming you already have a users collection with auth enabled
-  },
-  // ...
-  plugins: [
-    OAuth2Plugin({
-      enabled: true,
-      serverURL: process.env.NEXT_PUBLIC_URL || "http://localhost:3000",
-      authCollection: "users", // assuming you already have a users collection with auth enabled
-      clientId: process.env.CLIENT_ID || "",
-      clientSecret: process.env.CLIENT_SECRET || "",
-      tokenEndpoint: "https://oauth2.googleapis.com/token",
-      scopes: [
-        "https://www.googleapis.com/auth/userinfo.email",
-        "https://www.googleapis.com/auth/userinfo.profile",
-        "openid",
-      ],
-      providerAuthorizationUrl: "https://accounts.google.com/o/oauth2/v2/auth",
-      getUserInfo: async (accessToken: string) => {
-        const response = await fetch(
-          "https://www.googleapis.com/oauth2/v3/userinfo",
-          { headers: { Authorization: `Bearer ${accessToken}` } },
-        );
-        const user = await response.json();
-        return { email: user.email, sub: user.sub };
-      },
-      successRedirect: () => "/admin",
-      failureRedirect: () => "/login",
-    }),
-  ],
-  // ...
-});
+pnpm install payload-oauth2
 ```
 
 # Contributing
@@ -87,4 +50,4 @@ The MIT License (MIT). Please see [License File](LICENSE) for more information.
 
 # Credits
 
-This package was inspired by [Payload Plugin OAuth](https://github.com/thgh/payload-plugin-oauth)
+This package was inspired by [Payload Plugin OAuth](https://github.com/thgh/payload-plugin-oauth).

examples/google.md

@@ -0,0 +1,44 @@
+# Google OAuth2
+
+```ts
+export default buildConfig({
+  // ...
+  admin: {
+    importMap: { baseDir: path.resolve(dirname) },
+    components: {
+      // A simple button with <a> tag that links to your authorization path
+      // which defaults to /api/users/oauth/authorize
+      afterLogin: ["app/components/OAuthLoginButton#OAuthLoginButton"],
+    },
+    user: "users", // assuming you already have a users collection with auth enabled
+  },
+  // ...
+  plugins: [
+    OAuth2Plugin({
+      enabled: true,
+      serverURL: process.env.NEXT_PUBLIC_URL || "http://localhost:3000",
+      authCollection: "users", // assuming you already have a users collection with auth enabled
+      clientId: process.env.CLIENT_ID || "",
+      clientSecret: process.env.CLIENT_SECRET || "",
+      tokenEndpoint: "https://oauth2.googleapis.com/token",
+      scopes: [
+        "https://www.googleapis.com/auth/userinfo.email",
+        "https://www.googleapis.com/auth/userinfo.profile",
+        "openid",
+      ],
+      providerAuthorizationUrl: "https://accounts.google.com/o/oauth2/v2/auth",
+      getUserInfo: async (accessToken: string) => {
+        const response = await fetch(
+          "https://www.googleapis.com/oauth2/v3/userinfo",
+          { headers: { Authorization: `Bearer ${accessToken}` } },
+        );
+        const user = await response.json();
+        return { email: user.email, sub: user.sub };
+      },
+      successRedirect: () => "/admin",
+      failureRedirect: () => "/login",
+    }),
+  ],
+  // ...
+});
+```

test/plugin.spec.ts renamed to test/google.spec.ts

@@ -5,7 +5,7 @@ import { runCommand } from "./test-utils";
 dotenv.config();
 
 jest.setTimeout(1000 * 60 * 5); // 5 minutes
-describe("Plugin tests", () => {
+describe("Google OAuth2 Integration", () => {
   let _stopServer: (() => void) | null = null;
   let _serverResult: Promise<string | null> | null = null;
   let _browser: Browser | null = null;
@@ -37,7 +37,7 @@ describe("Plugin tests", () => {
     console.info("Browser started");
   });
 
-  it("Google OAuth", async () => {
+  it("Should work as expected", async () => {
     const GOOGLE_TEST_EMAIL = process.env.GOOGLE_TEST_EMAIL;
     if (typeof GOOGLE_TEST_EMAIL !== "string") {
       throw "GOOGLE_TEST_EMAIL not set";