@sanmid/flux 0.1.0 → 0.1.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +11 -4
- package/SECURITY.md +1 -1
- package/dist/index.js.map +1 -1
- package/package.json +12 -12
package/README.md
CHANGED
|
@@ -1,15 +1,22 @@
|
|
|
1
1
|
# Flux
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
**A design editor for your localhost.** Point to an element on the UI, tweak visual properties and copy the changes. The copied changes can be sent to any AI agent with the source to make the changes come alive.
|
|
4
|
+
|
|
5
|
+
**React only for now** — Flux ships as a React component; Vue, Svelte, and plain HTML apps are not supported yet.
|
|
6
|
+
|
|
7
|
+
---
|
|
4
8
|
|
|
5
9
|
## Install
|
|
6
10
|
|
|
7
11
|
```bash
|
|
8
|
-
|
|
9
|
-
# or: npm / yarn with the same peer dependencies
|
|
12
|
+
npm install @sanmid/flux -D
|
|
10
13
|
```
|
|
11
14
|
|
|
12
|
-
|
|
15
|
+
Or: `pnpm add -D @sanmid/flux` · `yarn add -D @sanmid/flux`
|
|
16
|
+
|
|
17
|
+
Icons, `clsx`, `tailwind-merge`, and `framer-motion` are **dependencies of Flux** — you do not install them separately. You only need **`react` and `react-dom` (18+)** in your app (Flux lists them as peer dependencies so one React instance is shared with your UI).
|
|
18
|
+
|
|
19
|
+
---
|
|
13
20
|
|
|
14
21
|
## Local development (localhost)
|
|
15
22
|
|
package/SECURITY.md
CHANGED
|
@@ -16,7 +16,7 @@ Flux is a **client-side React library** that runs in the browser alongside your
|
|
|
16
16
|
| **Clipboard** | Copy uses the browser **Clipboard API** / `execCommand('copy')` **after a user gesture** (e.g. clicking Copy). Prompt text reflects DOM and styles under the user’s control. |
|
|
17
17
|
| **Storage** | Preview state may be persisted to **`localStorage`** (namespaced keys) so edits survive reloads during development. Treat stored data as **sensitive as your page content**; clear site data if needed. |
|
|
18
18
|
| **DOM** | The editor injects UI (overlay, panel, drag layers) and may set temporary inline styles during drag/reposition. It applies preview CSS via a stylesheet; review `PreviewEngine` if you extend integration. |
|
|
19
|
-
| **Dependencies** | Runtime deps are limited (see `package.json`). Run `pnpm audit` / `npm audit` in your app and keep
|
|
19
|
+
| **Dependencies** | Runtime deps are limited (see `package.json`). Run `pnpm audit` / `npm audit` in your app and keep dependencies updated. |
|
|
20
20
|
|
|
21
21
|
## Production use
|
|
22
22
|
|