docs: Update description from animated to annotated

Clarifies that the tool creates annotated (not animated) replays
of text conversations. Updates description across README, package.json,
and CLI help text. Bumps version to 0.1.10.
This commit is contained in:
lennyzeltser
2026-01-15 00:29:10 -05:00
parent c6f72e0d3a
commit 29f9aa2efa
3 changed files with 4 additions and 4 deletions
+1 -1
View File
@@ -1,6 +1,6 @@
# Conversation Replay
Create animated replays of text conversations.
Create annotated replays of text conversations.
After parsing the annotated conversation data you supply in a YAML file, this tool will generate a self-contained embeddable HTML file. The published conversation can help with security awareness training and other communications that involve presenting an annotated text conversation.
+2 -2
View File
@@ -1,7 +1,7 @@
{
"name": "conversation-replay",
"version": "0.1.9",
"description": "Create animated text conversation replays",
"version": "0.1.10",
"description": "Create annotated replays of text conversations",
"main": "dist/cli.js",
"type": "module",
"bin": {
+1 -1
View File
@@ -13,7 +13,7 @@ import { buildDemo } from './generator';
import type { Theme } from './types';
const HELP = `
conversation-replay - Create animated conversation demos from YAML
conversation-replay - Create annotated replays of text conversations from YAML
Usage:
conversation-replay build <scenario.yaml> -o <output.html> [options]