convex-feedback-ui 0.1.9 → 0.2.0-beta.0

package/README.md

@@ -10,6 +10,8 @@
 
 Optional React DOM, React Native, and Expo Router UI for `convex-feedback`.
 
+This package provides the public feedback and roadmap experience. Internal priority and roadmap management live in the forkable [Clerk admin panel](../../apps/admin/withClerk/README.md), which uses the headless hooks directly.
+
 The package is intentionally layered:
 
 ```text
@@ -34,6 +36,22 @@ import "convex-feedback-ui/styles.css";
 <FeedbackScreen hooks={feedbackHooks} />;
 ```
 
+Use `RoadmapScreen` for the public roadmap and its attached feedback entries:
+
+```tsx
+import { RoadmapScreen } from "convex-feedback-ui";
+
+<RoadmapScreen
+  hooks={feedbackHooks}
+  onEntryOpen={(entryId) => navigate(`/feedback/${entryId}`)}
+  onUnauthenticated={() => openSignIn()}
+/>;
+```
+
+Roadmap browsing and attached-entry reads work without authentication. The
+`onUnauthenticated` callback is used for create, vote, like, and comment
+actions in the prebuilt screens; the host decides how to present sign-in.
+
 The default stylesheet:
 
 - has no Tailwind dependency;
@@ -315,7 +333,7 @@ Or combine global defaults with per-kind behavior:
 - The Expo entry point additionally uses `expo-constants` for app `version`, `build` number, `application ID`, `Expo runtime version`, and execution `environment` when available.
 - Generic React Native apps can provide app `version` and `build` values through `additional`.
 
-Metadata is stored in separate `standard` and `additional` sections. It is omitted from list and search results and from non-moderator reads. When the host's server-side actor resolver identifies a moderator, `getEntry` includes the metadata and the entry detail screen shows a metadata viewer.
+Metadata is stored in separate `standard` and `additional` sections. It is omitted from list and search results and from non-admin reads. When the host's server-side actor resolver identifies an admin, `getEntry` includes the metadata and the entry detail screen shows a metadata viewer.
 
 The platform collectors and `formatMetadataKey` helper are exported from their respective package entry points for custom integrations.