comment-mode 0.1.0 → 0.1.1

package/README.md

@@ -1,19 +1,6 @@
 ## Comment Mode
 
-Embeddable commenting for live prototypes (Next.js / React) that talks to your Comment Mode API.
-
-### Pushing to GitHub
-
-The project is already a git repo with an initial commit. To put it on GitHub:
-
-1. **Create a new repository** on [GitHub](https://github.com/new): name it e.g. `commentator` (or `comment-mode`). Do **not** initialize with a README, .gitignore, or license—they already exist locally.
-2. **Add the remote and push:**
-   ```bash
-   git remote add origin https://github.com/YOUR_USERNAME/commentator.git
-   git branch -M main
-   git push -u origin main
-   ```
-   Replace `YOUR_USERNAME` with your GitHub username (or org) and `commentator` with the repo name you chose.
+Embeddable commenting for live prototypes (Next.js / React). Add a comment overlay and threaded discussions to any prototype with minimal setup.
 
 ### Installation
 
@@ -32,8 +19,6 @@ function App() {
       config={{
         projectSlug: "my-prototype",
         surfaceId: window.location.pathname,
-        // Optional: override if you self-host the API
-        // apiBaseUrl: "https://api.commentmode.dev",
       }}
     >
       {/* your prototype UI */}
@@ -43,103 +28,14 @@ function App() {
 }
 ```
 
-The current implementation includes:
-
-- **CommentProvider**: React context that holds configuration and talks to the Comment Mode HTTP API.
-- **CommentOverlay**: A fullscreen overlay with a toggle button, persisted pins (threads), and a basic comments panel per pin.
-- **useComments**: Hook exposing thread and comment APIs (create thread, load comments, add comment).
-
-By default, the package calls the shared API at `https://api.commentmode.dev`. You can override with `apiBaseUrl` in the config if you run your own backend.
-
-### Backend API sketch
-
-At minimum, the backend behind `apiBaseUrl` should expose:
-
-- **POST `/threads`**
-  - Request JSON:
-
-    ```json
-    {
-      "projectSlug": "my-prototype",
-      "surfaceId": "/some/route",
-      "anchorX": 0.42,
-      "anchorY": 0.17
-    }
-    ```
-
-  - Response JSON:
-
-    ```json
-    {
-      "id": "thread-uuid"
-    }
-    ```
-
-This backend can be implemented in a separate Next.js app that owns your Supabase credentials and inserts rows into `threads` (and later `comments`, `users`, etc.).
-
-### Running the shared API (one backend for everyone)
-
-If you want to run a **shared API** so that everyone who installs `comment-mode` can use it without running their own backend:
-
-1. **Deploy the API**  
-   The `commentator-api` folder in this repo is a Next.js app. Deploy it to [Vercel](https://vercel.com) (or similar):
-   - Connect your GitHub repo and set the **root directory** to `commentator-api` (or deploy from inside that folder).
-   - Add **Environment Variables** in the Vercel project:
-     - `SUPABASE_URL` — your Supabase project URL
-     - `SUPABASE_SERVICE_ROLE_KEY` — service role key (API uses this for threads/comments)
-     - `SUPABASE_ANON_KEY` — anon key (exposed to the client via `/auth/config` for Supabase Auth)
-   - Deploy. Add your custom domain (e.g. `api.commentmode.dev`) in Vercel so the API is served there.
-
-2. **SDK default**  
-   The package already defaults to `https://api.commentmode.dev` (see `src/constants.ts`). After you deploy the API to that URL, run `npm run build` and publish the package; anyone who installs `comment-mode` will use your shared API by default.
-
-3. **Configure Supabase for production**  
-   In **Supabase Dashboard → Authentication → URL Configuration**:
-   - **Site URL**: your main production app URL (e.g. `https://commentmode.dev` or the URL of a prototype that uses the SDK).
-   - **Redirect URLs**: add every origin where the commenting UI will run (e.g. `https://commentmode.dev`, `https://commentmode.dev/**`, and any other prototype domains). You can add more later as people use the SDK on different sites.
-
-### Supabase URLs when going live
-
-If you run your own API (e.g. the `commentator-api` in this repo) and use Supabase Auth (magic link, GitHub, etc.), you must configure URLs in the **Supabase Dashboard** so auth works on production:
-
-1. **Authentication → URL Configuration**
-   - **Site URL**: set to your production app origin (e.g. `https://my-prototype.vercel.app`). This is the main URL where the SDK runs.
-   - **Redirect URLs**: add every origin where the commenting UI will load. For example:
-     - `https://my-prototype.vercel.app`
-     - `https://my-prototype.vercel.app/**`
-     - Any other prototype or app domains that use the same Comment Mode API.
-
-Without these, Supabase will block redirects from localhost-only and auth (sign-in, magic link) will fail on deployed sites.
-
-To build the package:
-
-```bash
-npm install
-npm run build
-```
-
-You can now link or publish the resulting package and import it into your Next.js prototypes.
-
-### Publishing to npm
-
-To publish this package as **comment-mode**:
-
-1. **npm account**  
-   Create an account at [npmjs.com](https://www.npmjs.com/signup) and log in with `npm login`.
-
-2. **Point repo URLs to your repo**  
-   In `package.json`, set `repository.url`, `bugs.url`, and `homepage` to your real GitHub (or other) repo (replace `your-org` with your org/username, e.g. `https://github.com/your-org/comment-mode`).
+**Config:**
 
-3. **Optional: LICENSE**  
-   A root `LICENSE` file (e.g. MIT) is included; update the copyright holder if needed.
+- **projectSlug** — Identifies your project (e.g. `"my-prototype"`).
+- **surfaceId** — Identifies the page/surface (e.g. `window.location.pathname`).
 
-4. **Publish**  
-   From the repo root:
-   ```bash
-   npm run build
-   npm publish
-   ```
 
-5. **Later releases**  
-   Bump `version` in `package.json` (e.g. `0.1.1`), then `npm publish` again.
+### What you get
 
+- **CommentProvider** — Wraps your app and connects to the Comment Mode API.
+- **CommentOverlay** — Fullscreen overlay with a toggle, comment pins (threads), and a panel to view/add comments.
+- **useComments** — Hook for creating threads, loading comments, and adding replies.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "comment-mode",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Embeddable commenting for live prototypes (Next.js/React) that talks to your Comment Mode API.",
   "main": "dist/index.js",
   "module": "dist/index.mjs",