feat: Add map sharing API

README.md

@@ -10,6 +10,60 @@ React wrapper for working with [`@comapeo/core`](https://github.com/digidem/coma
 npm install react @tanstack/react-query@5 @comapeo/core-react @comapeo/schema @comapeo/core @comapeo/ipc
 ```
 
+## Setup
+
+### Basic Setup
+
+Wrap your application with `ClientApiProvider` and a React Query `QueryClientProvider`:
+
+```tsx
+import { ClientApiProvider } from '@comapeo/core-react'
+import { QueryClient, QueryClientProvider } from '@tanstack/react-query'
+
+const queryClient = new QueryClient()
+
+function App() {
+	return (
+		<QueryClientProvider client={queryClient}>
+			<ClientApiProvider clientApi={clientApi}>
+				<MyApp />
+			</ClientApiProvider>
+		</QueryClientProvider>
+	)
+}
+```
+
+### Map Sharing Setup
+
+To use the map sharing hooks, you also need to wrap your application with `MapServerProvider`. Provide a `getBaseUrl` function that returns a Promise resolving to the base URL of your map server:
+
+```tsx
+import { MapServerProvider } from '@comapeo/core-react'
+import { createServer } from '@comapeo/map-server'
+
+const server = createServer()
+const listenPromise = server.listen()
+
+const getBaseUrl = async () => {
+	const { localPort } = await listenPromise
+	return new URL(`http://localhost:${localPort}/`)
+}
+
+function App() {
+	return (
+		<QueryClientProvider client={queryClient}>
+			<ClientApiProvider clientApi={clientApi}>
+				<MapServerProvider getBaseUrl={getBaseUrl}>
+					<MyApp />
+				</MapServerProvider>
+			</ClientApiProvider>
+		</QueryClientProvider>
+	)
+}
+```
+
+Hooks that communicate with the map server will wait for `getBaseUrl()` to resolve before making requests, so the provider can be mounted before the server is ready. You can also provide an optional `fetch` prop to use a custom fetch implementation.
+
 ## API Documentation
 
 Still a work in progress. Currently lives in [`docs/API.md`](./docs/API.md).