@sanmid/flux 0.1.0 → 0.1.1
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 +19 -4
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -1,15 +1,30 @@
|
|
|
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
|
+
**Why another line?** Some tools document a single install line because everything ships inside the package. Flux declares **peer dependencies** — small shared libraries your app installs next to Flux (npm does not add peers automatically):
|
|
18
|
+
|
|
19
|
+
```bash
|
|
20
|
+
npm install lucide-react clsx tailwind-merge framer-motion
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
(`pnpm add …` / `yarn add …` with the same names.) You already have `react` and `react-dom` (18+) in a React app.
|
|
24
|
+
|
|
25
|
+
**Peers:** `react`, `react-dom` (18+), `lucide-react`, `clsx`, `tailwind-merge`, `framer-motion`.
|
|
26
|
+
|
|
27
|
+
---
|
|
13
28
|
|
|
14
29
|
## Local development (localhost)
|
|
15
30
|
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@sanmid/flux",
|
|
3
|
-
"version": "0.1.
|
|
4
|
-
"description": "
|
|
3
|
+
"version": "0.1.1",
|
|
4
|
+
"description": "A design editor for your localhost — tweak UI in place and copy changes for any AI agent. React only.",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"author": "Sanmid Anavkar",
|
|
7
7
|
"repository": {
|