@veladent/booking-widget 0.0.0-stage → 1.0.4-dev.11

package/README.md

@@ -1,3 +1,39 @@
-# Temporary Holding Version
+# Veladent booking widget
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+The Veladent booking flow for React 19. Includes the complete widget, composable
+booking parts, a provider, hooks, and individual step components.
+
+```sh
+npm install @veladent/booking-widget
+```
+
+```tsx
+import { BookingWidget } from "@veladent/booking-widget";
+import "@veladent/booking-widget/styles.css";
+
+export function BookingPage() {
+  return (
+    <BookingWidget
+      baseUrl="YOUR_API_BASE_URL"
+      publishableKey="YOUR_SITE_PUBLISHABLE_KEY"
+    />
+  );
+}
+```
+
+React and React DOM 19 are peer dependencies. JavaScript, TypeScript declarations,
+and compiled CSS are included; no Tailwind configuration or monorepo checkout is
+required. For Next.js, render the widget from a client component and import the
+stylesheet from the application layout. The stylesheet includes Tailwind base
+styles and shared theme tokens; review its interaction with your application's
+existing styles.
+
+Use `@veladent/booking-widget@dev` or `@veladent/booking-widget@sandbox` for public
+prereleases. Without a channel, npm installs the stable (`latest`) release.
+
+All channels accept the API URL and site publishable key at runtime. Enable
+online booking for the site and allow the application's origin in booking
+settings. Never supply a server secret or npm token to this component.
+
+Use the `locale`, `timeZone`, and `theme` props for the site's settings. The
+widget preserves the booking flow's locale, timezone, and RTL behavior.