Skip to content
This repository was archived by the owner on Aug 15, 2025. It is now read-only.

Commit 003a9b9

Browse files
authored
Update README.md
1 parent 0e9ac74 commit 003a9b9

File tree

1 file changed

+4
-6
lines changed

1 file changed

+4
-6
lines changed

README.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@
44

55
TSCircuit Builder is a Typescript builder pattern for constructing schematic and PCB layouts. `@tscircuit/builder` is an internal module, [use tscircuit tsx instead](https://github.com/tscircuit/tscircuit). The builder is basically "the DOM for building circuits"
66

7+
> [!WARNING]
8+
>
9+
> `@tscircuit/builder` is replaced by `@tscircuit/core`
10+
711
TSCircuit TSX eventually renders to a builder. The builder will build
812
TSCircuit Soup, a JSON output. Soup can be rendered to
913
a webpage as either a schematic or PCB layout.
@@ -18,12 +22,6 @@ a webpage as either a schematic or PCB layout.
1822
> have to do while providing a lot of flexibility for different renderers. It's
1923
> like the DOM for Circuits.
2024
21-
> [!NOTE]
22-
>
23-
> `@tscircuit/builder` is going to be replaced by `@tscircuit/core` eventually,
24-
> the API and types are a bit wrong because it's an old package. Try to use
25-
> React with tscircuit to avoid building on the builder API (tscircuit React
26-
> has a much more permanent API)
2725

2826
## Example
2927

0 commit comments

Comments
 (0)