diff --git a/packages/astro-clerk-auth/README.md b/packages/astro-clerk-auth/README.md index 4d188f4..70e7783 100644 --- a/packages/astro-clerk-auth/README.md +++ b/packages/astro-clerk-auth/README.md @@ -1,6 +1,9 @@ # astro-clerk-auth Community package that integrates [Clerk](https://clerk.com/) with [Astro](https://astro.build/) +> [!IMPORTANT] +> This project has graduated to an [official SDK](https://clerk.com/changelog/2024-07-18-clerk-astro). Please proceed [here](https://clerk.com/docs/references/astro/migrating-from-astro-community-sdk) for migration instructions. + ## Live Demo [Online Demo](https://astro-clerk.elef.codes/) @@ -281,9 +284,9 @@ export function Header() { ### Use Clerk in Headless Mode -[Clerk Headless mode](https://clerk.com/docs/components/clerk-provider) (see `ClerkJSVariant` prop their docs) is a Clerk variant that is focused towards getting smaller bundle sizes. This variant does *not* include React or any client side components for Clerk (e.g. their signin component). Because of that the bundle size is drastically smaller. On top of that it also lazy loads the JavaScript client side. +[Clerk Headless mode](https://clerk.com/docs/components/clerk-provider) (see `ClerkJSVariant` prop their docs) is a Clerk variant that is focused towards getting smaller bundle sizes. This variant does *not* include React or any client side components for Clerk (e.g. their signin component). Because of that the bundle size is drastically smaller. On top of that it also lazy loads the JavaScript client side. -In order to use headless mode with this package, change your Astro configuration file to: +In order to use headless mode with this package, change your Astro configuration file to: ```diff import { defineConfig } from "astro/config"; diff --git a/packages/astro-clerk-auth/src/integration/create-integration.ts b/packages/astro-clerk-auth/src/integration/create-integration.ts index a9b334a..4ea7d18 100644 --- a/packages/astro-clerk-auth/src/integration/create-integration.ts +++ b/packages/astro-clerk-auth/src/integration/create-integration.ts @@ -27,6 +27,8 @@ function createIntegration

({ mode }: name: '@astro-clerk-auth/integration', hooks: { 'astro:config:setup': ({ config, injectScript, updateConfig, logger, command }) => { + logger.warn('This project has graduated to an official SDK. Please proceed to https://clerk.com/docs/references/astro/migrating-from-astro-community-sdk for migration instructions.'); + if (config.output === 'static') logger.error(`${packageName} requires SSR to be turned on. Please update output to "server"`);