@sanmid/flux 0.1.5 → 0.1.9

package/README.md

@@ -44,26 +44,15 @@ Open your app at `http://localhost:3000` (or your dev URL). Toggle the editor wi
 
 ## Tailwind
 
-Include the built bundle in `content` so utilities used inside Flux are generated:
-
-```js
-// tailwind.config.ts
-export default {
-  content: [
-    "./app/**/*.{ts,tsx}",
-    "./components/**/*.{ts,tsx}",
-    "./node_modules/@sanmid/flux/dist/index.js",
-  ],
-};
-```
+Flux **injects its own utility CSS** for light-DOM UI (floating toggle, panel chrome, etc.), so you **do not** need to add Flux to your Tailwind `content` for normal use.
+
+If you fork Flux or build from source and change its class names, add your paths (or the published bundle) to `content` so your build picks up those utilities.
 
 ## Next.js
 
-```js
-const nextConfig = {
-  transpilePackages: ["@sanmid/flux"],
-};
-```
+**No extra Next config** — the published build ships **ESM and CJS** (`package.json` `exports`) and a **`"use client"`** banner so the App Router can consume `@sanmid/flux` like any other dependency. Mount `DesignEditor` from a client component (as in [Local development](#local-development-localhost)) and you are done.
+
+If you ever hit a resolution error on an older Next.js release, try adding `transpilePackages: ["@sanmid/flux"]` to `next.config` as a fallback.
 
 ## Security
 
@@ -78,6 +67,16 @@ See [SECURITY.md](./SECURITY.md) for data handling (clipboard, `localStorage`, D
 
 Optional: enable **provenance** on supported registries for supply-chain transparency.
 
+## Repository layout
+
+| Path | Role |
+| --- | --- |
+| **`src/`** | Library source (TypeScript / React). |
+| **`dist/`** | Build output (not committed). Produced by `pnpm run build`. |
+| **`package.json` → `files`** | **Only** `dist`, `README.md`, `LICENSE`, and `SECURITY.md` are published to npm — that is what consumers install. |
+| **`playground/`** | Optional Vite app for local testing; **not** on npm, but usually **kept in git** so maintainers can run `pnpm run dev:playground` without a separate repo. |
+| **`scripts/`** | Tailwind → CSS strings, `tsup`, `prepend-use-client`. |
+
 ## Playground
 
 This repo includes a **private** Vite app under `playground/` for local demos. It is **not** part of the published npm artifact. See [CONTRIBUTING.md](./CONTRIBUTING.md).