@brandonlukas/luminar 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.
Files changed (2) hide show
  1. package/README.md +23 -0
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -12,6 +12,29 @@ npx @brandonlukas/luminar path/to/field.csv
12
12
 
13
13
  Optional flags: `--port 5173`, `--host 0.0.0.0`, `--preview` (uses production build)
14
14
 
15
+ ### CSV format
16
+
17
+ Your CSV should have four columns: x position, y position, x velocity, y velocity. Headers are optional and will be auto-detected.
18
+
19
+ **Example with header:**
20
+ ```csv
21
+ x,y,dx,dy
22
+ 0.0,0.0,1.2,0.5
23
+ 0.5,0.0,1.1,0.6
24
+ 1.0,0.0,0.9,0.7
25
+ 0.0,0.5,1.3,0.4
26
+ ```
27
+
28
+ **Example without header:**
29
+ ```csv
30
+ 0.0,0.0,1.2,0.5
31
+ 0.5,0.0,1.1,0.6
32
+ 1.0,0.0,0.9,0.7
33
+ 0.0,0.5,1.3,0.4
34
+ ```
35
+
36
+ Whitespace-separated values are also supported.
37
+
15
38
  ### Local development
16
39
 
17
40
  ```sh
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@brandonlukas/luminar",
3
- "version": "0.1.0",
3
+ "version": "0.1.1",
4
4
  "description": "Visualize 2D vector fields as looping particle flows with bloom and glow effects",
5
5
  "type": "module",
6
6
  "author": "Brandon Lukas",
@@ -47,4 +47,4 @@
47
47
  "dependencies": {
48
48
  "three": "^0.182.0"
49
49
  }
50
- }
50
+ }