@react-scad/core 0.1.9 → 0.1.11

package/README.md

@@ -1,23 +1,29 @@
-# react-scad
+# [react-scad](https://github.com/react-scad/react-scad) · [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/react-scad/react-scad/blob/main/LICENSE) [![npm version](https://img.shields.io/npm/v/@react-scad/core.svg?style=flat)](https://www.npmjs.com/package/@react-scad/core) [![Publish](https://github.com/react-scad/react-scad/actions/workflows/cicd.yml/badge.svg)](https://github.com/react-scad/react-scad/actions/workflows/cicd.yml) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/react-scad/react-scad#contributing)
 
-Render JSX to **OpenSCAD** models using the [React reconciler](https://github.com/facebook/react/tree/main/packages/react-reconciler).
+Render JSX to **SCAD** models using the [React reconciler](https://github.com/facebook/react/tree/main/packages/react-reconciler).
 
 - Describe models as a tree of components instead of imperative SCAD; avoids nested modules and parameter threading.
 - Same React/JSX mental model (components, props, composition), output is 3D.
 - Writes plain `.scad` files for [OpenSCAD](https://openscad.org/) or any slicer.
 
+---
+
 ## Preview
 
 ![Example](./assets/example.gif)
 
 *Rocket example with animated rotation.*
 
+---
+
 ## Why react-scad?
 
 SCAD is good for parametric 3D but scripts are imperative and nesting gets heavy; composing modules and passing parameters is tedious.
 
 A lot of people already think in components and JSX from building UIs. **react-scad** aims to facilitate that same way of thinking for parametric 3D.
 
+---
+
 ## Getting Started
 
 ### Prerequisites
@@ -31,7 +37,8 @@ A lot of people already think in components and JSX from building UIs. **react-s
 npm install react @react-scad/core
 ```
 
-With pnpm or yarn:
+<details>
+<summary>pnpm or yarn</summary>
 
 ```bash
 pnpm add react @react-scad/core
@@ -39,6 +46,8 @@ pnpm add react @react-scad/core
 yarn add react @react-scad/core
 ```
 
+</details>
+
 ### Minimal example
 
 Create a file `main.tsx` (or `main.jsx`):
@@ -57,14 +66,18 @@ root.render(
 );
 ```
 
-- `createRoot("model.scad")`: creates a root that writes to `model.scad`.
-- `Union`: CSG union of all children (like `union()` in SCAD).
-- `Cube` / `Sphere`: props match SCAD: `size`, `center`, `r`, `$fn`, etc.
+| Piece | Meaning |
+| ----- | ------- |
+| `createRoot("model.scad")` | Root that writes to `model.scad` |
+| `Union` | CSG union of all children (like `union()` in SCAD) |
+| `Cube` / `Sphere` | Props match SCAD: `size`, `center`, `r`, `$fn`, etc. |
 
 ### Run and write the `.scad` file
 
 Run your entry file with [tsx](https://github.com/privatenumber/tsx) so Node can execute the `.tsx`. The `.scad` file is written to the **current working directory** when you call `root.render()`.
 
+> **Note:** Node doesn’t run `.tsx` by itself. Use **tsx** or bundle with esbuild (see [Advanced](#advanced) for alternatives).
+
 ```bash
 npx tsx main.tsx
 ```
@@ -75,16 +88,18 @@ Watch mode (re-run on save):
 npx tsx watch main.tsx
 ```
 
-Run from the directory that contains `main.tsx` (or use the path to it).
+The path you pass to `createRoot()` is relative to the current working directory.
 
 ### View the result
 
 - Open the generated `.scad` file in [OpenSCAD](https://openscad.org/) to preview, export STL, or tweak.
 - Or import the `.scad` (or an exported STL) into your slicer for 3D printing.
 
+---
+
 ## Advanced
 
-To write to a custom path or get the SCAD string in memory instead of using `createRoot(path)`, use a container and `toScad`:
+To write to a custom path or get the SCAD string in memory instead of using `createRoot(path)`, use `createContainer()`, `render()`, and `toScad()`:
 
 ```jsx
 import { createContainer, render, toScad, Cube, Sphere, Union } from "@react-scad/core";
@@ -104,6 +119,10 @@ writeFileSync("out/model.scad", scadCode);
 // or use scadCode however you like
 ```
 
+Then run with `npx tsx main.tsx` or bundle with esbuild and run with Node.
+
+---
+
 ## Primitives (SCAD coverage)
 
 All listed SCAD primitives and operations are implemented. Prop names follow SCAD where it makes sense (`r`, `h`, `size`, `center`, `$fn`, etc.).
@@ -138,6 +157,12 @@ All listed SCAD primitives and operations are implemented. Prop names follow SCA
 | `surface()` | `Surface` | ✓ |
 | `import()` | `Import` | ✓ |
 
+### Missing anything?
+
+> If you need a SCAD primitive or feature that isn’t listed here, open an [issue](https://github.com/react-scad/react-scad/issues/new) or a PR.
+
+---
+
 ## Contributing
 
 1. **Fork and clone** the repo, then install dependencies:
@@ -155,10 +180,10 @@ All listed SCAD primitives and operations are implemented. Prop names follow SCA
 3. **Build and test** before committing:
    ```bash
    pnpm run build
-   pnpm run dev          # optional: smoke-test the example
+   pnpm run dev
    ```
 
-4. **Format and lint** (all code in the repo):
+4. **Format and lint** your code:
    ```bash
    pnpm run format
    pnpm run lint
@@ -168,11 +193,15 @@ All listed SCAD primitives and operations are implemented. Prop names follow SCA
 
 6. **Publishing** is done via GitHub Actions on push to `main`; no need to publish from a PR.
 
+---
+
 ## Acknowledgements
 
 - [React](https://react.dev/) and the [React reconciler](https://github.com/facebook/react/tree/main/packages/react-reconciler) for the rendering model that makes this approach possible.
 - [OpenSCAD](https://openscad.org/) for the SCAD language and documentation.
 
+---
+
 ## License
 
 MIT

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@react-scad/core",
-  "version": "0.1.9",
+  "version": "0.1.11",
   "description": "Render JSX to OpenSCAD models using the React reconciler",
   "keywords": [
     "react",