phoria2 1.0.0-rc.1 → 1.0.0-rc.3

package/README.md

@@ -7,7 +7,7 @@ business apps: charts, labelled scenes, diagrams, dashboards and product viewers
 - **Small**: about 46 KB gzipped for a lit, interactive scene; charts, particles and glTF are
   separate imports, and the heavier parts (shadows, HDR environments, GPU picking) load only when used.
 - **Idle when nothing changes**: a view draws only when something in it changed, so a dashboard of
-  many views costs nothing at rest.
+  many views only updates when needed.
 - **Tells you what to write**: every option is checked, and a mistake throws an error that names
   the fix - pass `colour` and you get `Material: use 'color'`. Written to be easy for coding
   agents too.
@@ -27,6 +27,28 @@ Or straight from a CDN, with no build step:
 </script>
 ```
 
+To use more than the core - charts, particles, glTF or motion - map each import to the package's own
+files, so they share one copy of the core (the CDN's ready-made `+esm` builds each bundle their
+own). Pin the version so a new release can't change your page:
+
+```html
+<script type="importmap">
+{
+  "imports": {
+    "phoria2": "https://cdn.jsdelivr.net/npm/phoria2@1.0.0-rc.3/dist/phoria2.js",
+    "phoria2/charts": "https://cdn.jsdelivr.net/npm/phoria2@1.0.0-rc.3/dist/charts.js",
+    "phoria2/particles": "https://cdn.jsdelivr.net/npm/phoria2@1.0.0-rc.3/dist/particles.js",
+    "phoria2/gltf": "https://cdn.jsdelivr.net/npm/phoria2@1.0.0-rc.3/dist/gltf.js",
+    "phoria2/motion": "https://cdn.jsdelivr.net/npm/phoria2@1.0.0-rc.3/dist/motion.js"
+  }
+}
+</script>
+<script type="module">
+  import { View } from 'phoria2'
+  import { chart } from 'phoria2/charts'
+</script>
+```
+
 ## A first scene
 
 ```html
@@ -106,16 +128,17 @@ export function SpinningBox({ color }) {
 ```
 
 A full example, with a chart that follows its data, is in
-[`examples/react`](https://github.com/kevinroast/kevs3d/tree/master/phoria2/examples/react).
+[`examples/react`](https://github.com/kevinroast/phoria2/tree/main/examples/react).
 
 ## What's in the package
 
 | Import | |
 |---|---|
-| `phoria2` | the view, scene graph, cameras, lights, materials, geometry, textures, picking, labels, `create()` from JSON |
+| `phoria2` | the view, scene graph, cameras, lights, materials, geometry, curves, textures, picking, labels, `create()` from JSON |
 | `phoria2/charts` | `chart()` - charts from a spec of mark, data and channels, and the scales they use |
 | `phoria2/particles` | `Emitter` and `Body` |
 | `phoria2/gltf` | `loadGLTF()` - glTF 2.0 models with their materials and animations |
+| `phoria2/motion` | `Timeline` - named steps played in order, `follow()` along a curve, `reveal()` a path as it's travelled - for explainers and guided tours |
 
 ## Browsers
 
@@ -123,9 +146,8 @@ Any browser with WebGL 2: current Chrome, Edge, Firefox and Safari (desktop and
 
 ## Examples
 
-The demo gallery shows each feature and a few showcase scenes; its source is in
-[`demos/`](https://github.com/kevinroast/kevs3d/tree/master/phoria2/demos). The design and the
-reasoning behind the API are in [`API-DESIGN.md`](https://github.com/kevinroast/kevs3d/blob/master/phoria2/API-DESIGN.md).
+The [demo gallery](https://kevs3d.co.uk/phoria2/) shows each feature and a few showcase scenes;
+its source is in [`demos/`](https://github.com/kevinroast/phoria2/tree/main/demos).
 
 ## Licence