@grundyjs/algiviz 0.7.0 → 0.7.1

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## 0.7.1 — 2026-10-15
+
+- Update package description and keywords for custom algorithm visualizations.
+- Improve the README introduction, demo links and standalone integration guide.
+- Add a BFS GIF preview exported with CanvasTake, hosted on GitHub.
+- No runtime API or behavior changes.
+
 ## 0.7.0 — 2026-10-15
 
 - Breaking: remove the deprecated /core entry point and bundled insertion/bubble

package/README.md

@@ -1,19 +1,56 @@
 # AlgiViz
 
-A TypeScript toolkit for user-defined algorithm visualizations. You write the
-algorithm and define your objects; AlgiViz provides array operations, playback,
-typed scene dispatch and a ready-made Canvas array renderer. No runtime dependencies.
-Playback works without DOM, React or Next.js. ESM only, with TypeScript declarations.
+**Your algorithms and objects. Step-by-step playback and custom rendering.**
 
-This README describes version 0.7.0.
+![BFS from A: custom graph vertices, edges and queue animated with AlgiViz](https://raw.githubusercontent.com/urffin/algiviz/master/docs/assets/bfs.gif)
 
-## Minimal custom object
+*An application-owned BFS algorithm with custom objects. Exported with
+[CanvasTake](https://github.com/urffin/canvas-take) —
+[try an interactive sorting demo](https://grundyjs.ru/algorithms/insertion-sort/)
+or explore the [BFS source](https://github.com/urffin/algiviz/blob/master/examples/graph-demo.mjs).*
 
-Start with [the standalone example](examples/minimal.html) and its
-[complete module](examples/minimal.mjs). It defines a custom token, emits immutable
-steps and draws interpolated positions using only public package imports.
-No shared demo controller is needed. See [the walkthrough](docs/minimal-example.md)
-for running it in your own application.
+A TypeScript toolkit for building interactive algorithm explanations. Write your
+algorithm as a generator, emit immutable states and choose how your objects look.
+AlgiViz handles playback and scene matching; optional array operations and a Canvas
+renderer help you get started.
+
+[Live sorting demo](https://grundyjs.ru/algorithms/insertion-sort/) ·
+[Library overview](https://grundyjs.ru/algiviz/) ·
+[npm package](https://www.npmjs.com/package/@grundyjs/algiviz) ·
+[Minimal example source](https://github.com/urffin/algiviz/blob/master/examples/minimal.mjs)
+
+- **Your algorithm:** control the loops, conditions and order of operations.
+- **Your objects:** define custom types and handlers for Canvas, SVG or another target.
+- **Two playback modes:** retain history for seeking, or consume a generator with
+  only adjacent snapshots retained by the player.
+- **No runtime dependencies:** ESM and TypeScript declarations; playback works
+  without DOM, React or Next.js.
+
+Use it for educational demos, interactive articles and algorithm walkthroughs.
+Algorithms and layouts belong to your application; AlgiViz provides the playback
+and rendering API. This README describes version 0.7.1.
+
+## Start with one custom object
+
+The [standalone page](https://github.com/urffin/algiviz/blob/master/examples/minimal.html)
+moves one token with a generator and a custom Canvas handler. It uses only public
+package imports, without the shared demo controller. Copy its
+[complete module](https://github.com/urffin/algiviz/blob/master/examples/minimal.mjs)
+into your application and connect a canvas:
+
+```js
+import { createTokenPlayer } from './minimal.mjs';
+
+const canvas = document.querySelector('canvas');
+const player = createTokenPlayer(canvas.getContext('2d'));
+player.advance(100); // Advance playback by 100 ms.
+// Call advance(deltaMs) from your controls or animation loop.
+// Call player.dispose() when removing the visualization.
+```
+
+[Follow the walkthrough](https://github.com/urffin/algiviz/blob/master/docs/minimal-example.md)
+for local setup, snapshot ownership and lifecycle. For a larger custom-object
+example, see the [graph BFS walkthrough](https://github.com/urffin/algiviz/blob/master/docs/custom-graph-example.md).
 
 ## Install
 
@@ -462,7 +499,7 @@ candidate commit.
 
 The [publish workflow](.github/workflows/npm-publish.yml) runs when a stable GitHub
 Release is published. Drafts, prereleases and tag pushes alone do not publish.
-Use `v` followed by the exact package version, such as `v0.7.0`, at the tested commit.
+Use `v` followed by the exact package version, such as `v0.7.1`, at the tested commit.
 
 The workflow uses Node.js 24 and npm 11, checks the version and packed consumer,
 then publishes with provenance through npm trusted publishing (OIDC).

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@grundyjs/algiviz",
-  "version": "0.7.0",
-  "description": "Deterministic algorithm steps for educational visualizations",
+  "version": "0.7.1",
+  "description": "TypeScript toolkit for custom algorithm visualizations with step-by-step playback and extensible rendering",
   "type": "module",
   "files": [
     "dist/array",
@@ -52,10 +52,14 @@
   },
   "homepage": "https://grundyjs.ru/algiviz/",
   "keywords": [
+    "algorithm-visualization",
     "algorithms",
     "visualization",
-    "insertion-sort",
-    "bubble-sort",
+    "animation",
+    "step-by-step",
+    "playback",
+    "data-structures",
+    "educational",
     "canvas",
     "typescript"
   ],