@poly-x/react 0.1.0 → 0.2.0

package/README.md

@@ -41,11 +41,42 @@ function Dashboard() {
 Add a callback route (`/auth/callback`) that renders `<AuthCallback />` to
 complete sign-in.
 
+## Profile self-service
+
+`<UserProfile>` gives a signed-in person a dialog to correct their own details —
+first name, last name, phone number, national ID, gender and photo. You write no
+form, no validation rules and no upload handling:
+
+```tsx
+import { UserProfile } from "@poly-x/react";
+
+<UserProfile onSaved={() => router.refresh()} />;
+```
+
+Most apps want it on the account menu instead of as its own button:
+
+```tsx
+<UserButton showUserProfile />
+```
+
+That turns the existing **Manage account** entry into one that opens the dialog.
+It is opt-in, and `manageAccountUrl` always wins — so an app already linking that
+entry to its own page keeps exactly what it has.
+
+Requires `@poly-x/next`'s route handler to be mounted (the platform call is made
+server-side; the browser never holds a credential). Validation mirrors the
+platform's own rules, so a value the dialog accepts is one the platform accepts.
+
+Editing anybody **else's** profile is not offered here — that is administration,
+and it lives in the PolyX console with the permission model and audit trail.
+Email, username and password are likewise excluded: each has its own verification
+path that a profile form must not route around.
+
 ## API
 
 `PolyXProvider` · `useAuth` (`isLoaded`, `isSignedIn`, `signIn`, `signOut`,
 `getToken`) · `useUser` · `useSession` · `<SignIn>` · `<Protected>` ·
-`<AuthCallback>`. Sign-in defaults to a popup; pass `mode="redirect"` for a
-full-page flow.
+`<UserButton>` · `<UserProfile>` · `<AuthCallback>`. Sign-in defaults to a popup;
+pass `mode="redirect"` for a full-page flow.
 
 MIT licensed.