From 1be8429b28b2b5063ef8e9434e5a1ba2c567be81 Mon Sep 17 00:00:00 2001 From: Cameron Matheson Date: Wed, 7 Aug 2024 15:33:53 -0600 Subject: [PATCH 1/2] improve README --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 944b330..d81ba6e 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,11 @@ or yarn add @workos-inc/authkit-react ``` +## Setup + +Add your site URL to the list of allowed origins in the WorkOS dashboard by +clicking on the "Configure sessions" button of the "Authentication" page. + ## Usage ```jsx @@ -19,7 +24,7 @@ import { useAuth, AuthKitProvider } from "@workos-inc/authkit-react"; function Root() { return ( - + ); @@ -73,6 +78,7 @@ Your app should be wrapped in the `AuthKitProvider` component. This component takes the following props: * `clientId` (required): Your `WORKOS_CLIENT_ID` +* `apiHostname`: Defaults to `api.workos.com`. This should be set to your custom Authentication API domain in production. * `redirectUri`: The url that WorkOS will redirect to upon successful authentication. (Used when constructing sign-in/sign-up URLs). * `devMode`: Defaults to `true` if window.location is "localhost" or "127.0.0.1". Tokens will be stored in localStorage when this prop is true. * `onRedirectCallback`: Called after exchanging the From d39ebf13058da1c874a18c0f6e44e3104f2d6b04 Mon Sep 17 00:00:00 2001 From: Cameron Matheson Date: Wed, 7 Aug 2024 15:40:26 -0600 Subject: [PATCH 2/2] Update README.md Co-authored-by: Michael Hadley --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index d81ba6e..6f0b070 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ yarn add @workos-inc/authkit-react ## Setup -Add your site URL to the list of allowed origins in the WorkOS dashboard by +Add your site's URL to the list of allowed origins in the WorkOS dashboard by clicking on the "Configure sessions" button of the "Authentication" page. ## Usage