@sanity/sdk-react 0.0.0-alpha.3 → 0.0.0-alpha.31

package/README.md

@@ -2,110 +2,16 @@
   <a href="https://sanity.io">
     <img src="https://cdn.sanity.io/images/3do82whm/next/1dfce9dde7a62ccaa8e8377254a1e919f6c07ad3-128x128.svg" />
   </a>
-  <h1 align="center">Sanity SDK - React</h1>
+  <h1 align="center">Sanity React App SDK</h1>
 </p>
 
-React components and hooks for creating Sanity applications.
+React hooks for creating Sanity applications.
 
-## Installation
+## Documentation
 
-```bash
-npm i @sanity/sdk-react @sanity/sdk
-```
-
-## SDK Documentation
-
-See the [SDK Documentation](https://sdk-docs.sanity.dev) for more information.
-
-## Quick Start
-
-Here's how to implement your Sanity application:
-
-```bash
-# Create a new Vite React TypeScript project
-npm create vite@latest my-content-os-app -- --template react-ts -y
-cd my-content-os-app
-# Install Sanity dependencies
-npm i @sanity/sdk-react @sanity/sdk @sanity/ui
-# Run the app
-npm run dev
-```
-
-```tsx
-// src/App.tsx
-import {createSanityInstance} from '@sanity/sdk'
-import {AuthBoundary, SanityProvider} from '@sanity/sdk-react/components'
-import {useCurrentUser, useLogOut} from '@sanity/sdk-react/hooks'
-import {Button, Flex, Spinner, Text, ThemeProvider} from '@sanity/ui'
-import {buildTheme} from '@sanity/ui/theme'
-import {Suspense} from 'react'
-
-const theme = buildTheme({})
-const sanityInstance = createSanityInstance({
-  projectId: '<your-project-id>',
-  dataset: '<your-dataset>',
-  // optional auth config set projectId and dataset to '' and authScope to 'org' for a global token
-  // auth: {
-  //   authScope: 'org',
-  //   ...
-  // },
-})
-
-export function App(): JSX.Element {
-  return (
-    <ThemeProvider theme={theme}>
-      <Suspense fallback={<Spinner />}>
-        <SanityProvider sanityInstance={sanityInstance}>
-          <AuthBoundary header={<Text>My Sanity App</Text>}>
-            <Authenticated />
-          </AuthBoundary>
-        </SanityProvider>
-      </Suspense>
-    </ThemeProvider>
-  )
-}
-
-function Authenticated() {
-  const currentUser = useCurrentUser()
-  const logout = useLogOut()
-
-  return (
-    <Flex direction="column" gap={2}>
-      <Text>Hello, {currentUser?.name}!</Text>
-      <Button text="Logout" onClick={logout} mode="ghost" />
-    </Flex>
-  )
-}
-
-export default App
-```
-
-## Customizing your application
-
-If you would like to implement a custom look and feel, you can use the hooks in your own components.
-
-## Available Hooks
-
-- `useAuthState` - Get current authentication state
-- `useCurrentUser` - Access the currently authenticated user
-- `useAuthToken` - Access the authentication token
-- `useLoginUrls` - Get OAuth login URLs
-- `useLogOut` - Handle user logout
-- `useSanityInstance` - Access the Sanity client instance
-- and more...
-
-## TypeScript Support
-
-This package includes TypeScript definitions. You can import types like:
-
-```tsx
-import type {
-  SanityProviderProps,
-  AuthBoundaryProps,
-  LoginLayoutProps,
-  LoginErrorProps,
-} from '@sanity/react'
-```
+- Familiarize yourself with the App SDK via a conceptual overview, a quickstart guide, and a step by step walkthrough on **[the Sanity Docs site](https://sanity.io/docs/app-sdk)**
+- Go in depth with the **[App SDK reference docs](https://sdk-docs.sanity.dev)**
+- View example implementations on the **[SDK Explorer](https://sdk-examples.sanity.dev)**
 
 ## License