conversation-replay 0.1.1 → 0.1.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +48 -11
  2. package/package.json +7 -2
package/README.md CHANGED
@@ -1,11 +1,15 @@
1
1
  # Conversation Replay
2
2
 
3
- Conversation Replay is a "video" player for conversations.
3
+ Create animated replays of text conversations.
4
4
 
5
- After parsing the annotated conversation data you supply in a YAML file, this tool will generate a self-contained embeddable replay that uses HTML, JavaScript, and CSS. This can be help in security awareness, training, and web publishing situations.
5
+ 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.
6
6
 
7
7
  - [Conversation Replay](#conversation-replay)
8
8
  - [How This Is Useful](#how-this-is-useful)
9
+ - [Installation](#installation)
10
+ - [Run Without Installing (Recommended)](#run-without-installing-recommended)
11
+ - [Global Install](#global-install)
12
+ - [Install from GitHub](#install-from-github)
9
13
  - [Quick Start](#quick-start)
10
14
  - [YAML Schema](#yaml-schema)
11
15
  - [Basic Structure](#basic-structure)
@@ -30,7 +34,7 @@ After parsing the annotated conversation data you supply in a YAML file, this to
30
34
 
31
35
  ## How This Is Useful
32
36
 
33
- Security training often involves showing how attacks unfold through conversation—phishing emails, social engineering calls, BEC attempts, scammer chat interactions. Static screenshots lose the temporal element. Video production is time-consuming and hard to update.
37
+ Security training often involves showing how attacks unfold through text conversations—phishing emails, social engineering calls, BEC attempts, scammer chat interactions. Static screenshots lose the temporal element. Video production is time-consuming and hard to update.
34
38
 
35
39
  Conversation Replay lets you:
36
40
 
@@ -39,20 +43,53 @@ Conversation Replay lets you:
39
43
  - **Slick Design:** Modern UI, nice typography, clean colors, and smooth animations
40
44
  - **Embed Anywhere:** Seamlessly integrates into blogs and LMS platforms
41
45
 
42
- Want to see it in action? Open the pre-generated demo replays [examples/london-scam.html](examples/london-scam.html) or [examples/ir-report.html](examples/ir-report.html) directly in your browser.
46
+ Want to see it in action? Open the pre-generated demo replays [examples/london-scam.html](examples/london-scam.html) or [examples/ir-report.html](examples/ir-report.html) in your browser.
43
47
 
44
- ## Quick Start
48
+ ## Installation
49
+
50
+ ### Run Without Installing (Recommended)
45
51
 
46
- To build your own conversation replay:
52
+ The easiest way to use Conversation Replay—no installation required—after you create the annotated conversation file demo.yaml:
47
53
 
48
54
  ```bash
49
- # Prerequisite: Bun (https://bun.sh) or Node.js 18+
55
+ # Using npx (comes with Node.js)
56
+ npx conversation-replay build demo.yaml -o demo.html
50
57
 
51
- # Install dependencies
52
- bun install
58
+ # Using bunx (comes with Bun)
59
+ bunx conversation-replay build demo.yaml -o demo.html
60
+ ```
53
61
 
54
- # Build a demo from YAML
55
- bun run src/cli.ts build examples/london-scam.yaml -o demo.html
62
+ ### Global Install
63
+
64
+ For frequent use, install globally:
65
+
66
+ ```bash
67
+ # Using npm
68
+ npm install -g conversation-replay
69
+
70
+ # Using Bun
71
+ bun add -g conversation-replay
72
+
73
+ # Then run directly
74
+ conversation-replay build demo.yaml -o demo.html
75
+ ```
76
+
77
+ ### Install from GitHub
78
+
79
+ To install the latest development version directly from GitHub:
80
+
81
+ ```bash
82
+ npm install -g github:lennyzeltser/conversation-replay
83
+ ```
84
+
85
+ Note: This requires [Bun](https://bun.sh) to be installed (for the build step).
86
+
87
+ ## Quick Start
88
+
89
+ Create a YAML file defining your conversation, then generate the HTML:
90
+
91
+ ```bash
92
+ conversation-replay build examples/london-scam.yaml -o demo.html
56
93
  ```
57
94
 
58
95
  Output:
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "conversation-replay",
3
- "version": "0.1.1",
4
- "description": "Create animated conversation demos from YAML for security awareness, IR training, and communication skills education",
3
+ "version": "0.1.6",
4
+ "description": "Create animated text conversation replays",
5
5
  "main": "dist/cli.js",
6
6
  "type": "module",
7
7
  "bin": {
@@ -16,6 +16,7 @@
16
16
  "validate": "bun run src/cli.ts validate",
17
17
  "example": "bun run src/cli.ts build examples/london-scam.yaml -o examples/london-scam.html",
18
18
  "build:dist": "bun build src/cli.ts --target=node --outfile=dist/cli.js --packages=bundle",
19
+ "prepare": "bun run build:dist",
19
20
  "prepublishOnly": "bun run build:dist"
20
21
  },
21
22
  "keywords": [
@@ -29,6 +30,10 @@
29
30
  ],
30
31
  "author": "Lenny Zeltser",
31
32
  "license": "MIT",
33
+ "repository": {
34
+ "type": "git",
35
+ "url": "https://github.com/lennyzeltser/conversation-replay"
36
+ },
32
37
  "devDependencies": {
33
38
  "@types/bun": "latest"
34
39
  },