rtistree 0.5.0 → 0.6.0

package/examples/hello/README.md

@@ -1,14 +1,30 @@
-# First image
+# Your first Rtistree project
 
-From a directory with `rtistree` installed, copy these three files into your project.
+Run these commands inside a project created by `npx rtistree@latest init my-art`.
+If you are reading this in the repository’s `examples/hello` directory, create a project
+first: these are template files, and `init` supplies the package.json and npm scripts.
 
 ```sh
-npx graphics render scene.json -o hello.png
-npx graphics apply scene.json refine.json
-npx graphics render scene.json -o brighter.png
-npx graphics undo scene.json
-npx graphics render scene.json -o restored.png
+npm install
+npm run render
+```
+
+Open `hello.png`. `scene.json` defines the disc and title; `refine.json` is a sample local edit.
+
+## Refine and undo
+
+```sh
+npx rtistree apply scene.json refine.json
+npx rtistree render scene.json -o brighter.png
+npx rtistree undo scene.json
+npx rtistree render scene.json -o restored.png
 ```
 
 `restored.png` should match `hello.png` byte for byte on the same runtime and platform.
-`render.mjs` demonstrates the SDK; run it with `node render.mjs`.
+The edit journal lives in `history/`; keep it with the scene to retain your current edits.
+
+## SDK
+
+Run `npm run render:sdk` to execute `render.mjs` and create `sdk-output.png`.
+
+[Getting started](https://rtistree.dev/docs/getting-started/) · [Agent setup](https://rtistree.dev/docs/agent-setup/)

package/examples/hello/render.mjs

@@ -1,7 +1,8 @@
 import { Project, rtistreeAgentInstructions, artDirectionGuide } from 'rtistree';
+import { fileURLToPath } from 'node:url';
 import { writeFile } from 'node:fs/promises';
 
-const project = await Project.open(new URL('./scene.json', import.meta.url).pathname);
+const project = await Project.open(fileURLToPath(new URL('./scene.json', import.meta.url)));
 const result = await project.render();
 await writeFile(new URL('./sdk-output.png', import.meta.url), result.png);
 console.log({ width: result.width, height: result.height, guide: artDirectionGuide.version });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rtistree",
-  "version": "0.5.0",
+  "version": "0.6.0",
   "description": "Deterministic, agent-operable raster graphics engine",
   "main": "./dist/index.js",
   "scripts": {
@@ -11,11 +11,13 @@
     "graphics": "node --import tsx src/cli.ts",
     "demo": "node --import tsx scripts/demo.ts",
     "schema": "node --import tsx scripts/schema.ts",
-    "format": "prettier --write src tests scripts docs examples schemas README.md package.json tsconfig.json .github .prettierrc.json",
-    "format:check": "prettier --check src tests scripts docs examples schemas README.md package.json tsconfig.json .github .prettierrc.json",
+    "format": "prettier --write src tests scripts docs examples schemas README.md package.json tsconfig.json .github .prettierrc.json release-please-config.json .release-please-manifest.json CONTRIBUTING.md",
+    "format:check": "prettier --check src tests scripts docs examples schemas README.md package.json tsconfig.json .github .prettierrc.json release-please-config.json .release-please-manifest.json CONTRIBUTING.md",
     "performance": "node --import tsx scripts/performance.ts",
     "prepack": "npm run build",
-    "package:check": "node scripts/package-smoke.mjs"
+    "package:check": "node scripts/package-smoke.mjs",
+    "rtistree": "node --import tsx src/cli.ts",
+    "docs:check": "npm run build && node scripts/docs-smoke.mjs"
   },
   "keywords": [
     "graphics",
@@ -52,6 +54,7 @@
     ".": "./dist/index.js"
   },
   "bin": {
+    "rtistree": "./dist/cli.js",
     "graphics": "./dist/cli.js"
   },
   "engines": {
@@ -66,7 +69,9 @@
     "CHANGELOG.md",
     "THIRD_PARTY_NOTICES.md",
     "licenses",
-    "examples/hello"
+    "examples/hello",
+    "SECURITY.md",
+    "CONTRIBUTING.md"
   ],
   "license": "MIT",
   "author": "Colum Ferry",