@tscircuit/footprinter 0.0.38 → 0.0.39

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 +32 -5
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -42,12 +42,39 @@ fp.string("dip4_w7.62mm") // same as fp.dip(4).w(7.62)
42
42
  fp.string("dip4_w0.3in") // same as fp.dip(4).w("0.3in")
43
43
  ```
44
44
 
45
- ## Magic
45
+ ## Getting JSON output from the builder
46
46
 
47
- `footprinter` comes with a `fp.magic` function which calls a remote server that
48
- attempts to convert the specified string into a `footprinter` string. This can
49
- help when you're looking at a random package designator from an online site. You
50
- should always confirm these footprints against the datasheet.
47
+ Use the `.soup()` function to output [tscircuit soup JSON](https://github.com/tscircuit/soup)
48
+
49
+ ```ts
50
+ fp.string("res0402").soup()
51
+ /*
52
+ [
53
+ {
54
+ type: 'pcb_smtpad',
55
+ x: -0.5,
56
+ y: 0,
57
+ width: 0.6000000000000001,
58
+ height: 0.6000000000000001,
59
+ layer: 'top',
60
+ shape: 'rect',
61
+ pcb_smtpad_id: '',
62
+ port_hints: [ '1' ]
63
+ },
64
+ {
65
+ type: 'pcb_smtpad',
66
+ x: 0.5,
67
+ y: 0,
68
+ width: 0.6000000000000001,
69
+ height: 0.6000000000000001,
70
+ layer: 'top',
71
+ shape: 'rect',
72
+ pcb_smtpad_id: '',
73
+ port_hints: [ '2' ]
74
+ }
75
+ ]
76
+ */
77
+ ```
51
78
 
52
79
  ## Generation Defaults
53
80
 
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@tscircuit/footprinter",
3
3
  "type": "module",
4
- "version": "0.0.38",
4
+ "version": "0.0.39",
5
5
  "description": "",
6
6
  "main": "dist/index.cjs",
7
7
  "files": [