@mediansh/widget 0.1.0

package/README.md

@@ -0,0 +1,86 @@
+# @mediansh/widget
+
+The Median support widget. A launcher in the corner of your site opens into a
+support panel. An AI agent answers first, your team picks up in the Median
+inbox, and replies stream back to the visitor. There is no connection or
+message list to manage.
+
+## Install
+
+```sh
+npm install @mediansh/widget
+```
+
+Import the stylesheet once, wherever your global CSS lives:
+
+```ts
+import "@mediansh/widget/styles.css";
+```
+
+## React
+
+```tsx
+import { MedianSupport } from "@mediansh/widget";
+
+<MedianSupport apiKey="median_pk_..." />;
+```
+
+Mount it once, anywhere in your tree. The `median_pk_` id is derived from
+your server's `MEDIAN_KEY`; the docs show the one line helper.
+
+## Without React
+
+```ts
+import { mountMedianSupport } from "@mediansh/widget";
+
+const support = mountMedianSupport({ apiKey: "median_pk_..." });
+```
+
+Same widget, same options, on any page with a bundler. The instance returns
+`update` for new options and `unmount` to take it off the page. React
+installs alongside as a peer dependency; your app does not use it.
+
+## Control it from anywhere
+
+```ts
+import { medianSupport } from "@mediansh/widget";
+
+medianSupport.open();
+medianSupport.attach("Crash trace", error.stack);
+medianSupport.reportError(error); // from your error screen
+medianSupport.reset(); // on sign out
+```
+
+React components can use `useMedianSupport()` for the same control with a
+live `isOpen`.
+
+## Feedback
+
+A second panel, for notes rather than questions. It wraps a trigger of your
+own and opens under it:
+
+```tsx
+import { MedianFeedback } from "@mediansh/widget";
+
+<MedianFeedback apiKey="median_pk_...">
+  <button>Share feedback</button>
+</MedianFeedback>;
+```
+
+One box and one button. A model reads the note and files it as a bug or a
+suggestion, or drops it as spam. Nobody picks a category or writes a title,
+and the page it was written on rides along.
+
+`mountMedianFeedback` is the version for pages without React, and
+`medianFeedback` / `useMedianFeedback()` open it from anywhere else.
+
+## Theming
+
+Both panels read shadcn-style CSS variables from your page and fall back to
+a plain light theme without them. They inherit your font.
+
+## Docs
+
+Props, identity, diagnostics, feedback, and agent tools:
+[docs.median.sh](https://docs.median.sh), or the source at
+[github.com/mediansh/median](https://github.com/mediansh/median).