mirror of
https://github.com/lennyzeltser/conversation-replay
synced 2026-06-21 13:55:53 +00:00
chore: Clean up repo and update description
- Remove CLAUDE.md, example.yaml, .cursor/ - Simplify AGENTS.md to redirect to README - Update package description - Add .cursor to .gitignore
This commit is contained in:
@@ -1 +0,0 @@
|
||||
../../CLAUDE.md
|
||||
@@ -30,5 +30,8 @@ report.[0-9]_.[0-9]_.[0-9]_.[0-9]_.json
|
||||
# IntelliJ based IDEs
|
||||
.idea
|
||||
|
||||
# Cursor IDE
|
||||
.cursor
|
||||
|
||||
# Finder (MacOS) folder config
|
||||
.DS_Store
|
||||
|
||||
@@ -1,11 +1,3 @@
|
||||
# Agents
|
||||
# AI Agent Instructions
|
||||
|
||||
Before working on this project, review [README.md](./README.md) for:
|
||||
- Project purpose: CLI tool generating animated conversation demos from YAML
|
||||
- YAML schema for scenarios, participants, and steps
|
||||
- Repository structure and key source files
|
||||
- Development commands and architecture
|
||||
- Security considerations (input validation, output safety)
|
||||
- Key logic: `src/generator.ts` handles the Premium UI (glassmorphism), automatic embedding detection, and multi-scenario logic.
|
||||
|
||||
See the **AI Agent Quick Reference** section for file locations and common tasks.
|
||||
See [README.md](./README.md) for project documentation.
|
||||
|
||||
@@ -1,7 +0,0 @@
|
||||
# Claude Code Instructions
|
||||
|
||||
## Git Workflow
|
||||
|
||||
- Commit directly to master, no feature branches
|
||||
- Do not create PRs
|
||||
- Push to origin after committing
|
||||
@@ -1,12 +1,15 @@
|
||||
# Conversation Replay
|
||||
|
||||
Conversation Replay is a "video" player for conversations.
|
||||
Create animated replays of text conversations.
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
- [Conversation Replay](#conversation-replay)
|
||||
- [How This Is Useful](#how-this-is-useful)
|
||||
- [Installation](#installation)
|
||||
- [Run Without Installing (Recommended)](#run-without-installing-recommended)
|
||||
- [Global Install](#global-install)
|
||||
- [Install from GitHub](#install-from-github)
|
||||
- [Quick Start](#quick-start)
|
||||
- [YAML Schema](#yaml-schema)
|
||||
- [Basic Structure](#basic-structure)
|
||||
@@ -31,7 +34,7 @@ After parsing the annotated conversation data you supply in a YAML file, this to
|
||||
|
||||
## How This Is Useful
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
Conversation Replay lets you:
|
||||
|
||||
@@ -40,13 +43,13 @@ Conversation Replay lets you:
|
||||
- **Slick Design:** Modern UI, nice typography, clean colors, and smooth animations
|
||||
- **Embed Anywhere:** Seamlessly integrates into blogs and LMS platforms
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
## Installation
|
||||
|
||||
### Run Without Installing (Recommended)
|
||||
|
||||
The easiest way to use Conversation Replay—no installation required:
|
||||
The easiest way to use Conversation Replay—no installation required—after you create the annotated conversation file demo.yaml:
|
||||
|
||||
```bash
|
||||
# Using npx (comes with Node.js)
|
||||
|
||||
@@ -1,32 +0,0 @@
|
||||
meta:
|
||||
title: Example Conversation
|
||||
description: A test scenario to evaluate the UI.
|
||||
theme: chat
|
||||
|
||||
scenarios:
|
||||
- id: scenario1
|
||||
title: Basic Chat
|
||||
participants:
|
||||
- id: user
|
||||
label: User
|
||||
role: left
|
||||
- id: ai
|
||||
label: Assistant
|
||||
role: right
|
||||
steps:
|
||||
- type: message
|
||||
from: user
|
||||
content: "Hello, can you help me with something?"
|
||||
- type: message
|
||||
from: ai
|
||||
content: "Of course! What do you need help with?"
|
||||
- type: annotation
|
||||
content: "The assistant is ready to help."
|
||||
- type: message
|
||||
from: user
|
||||
content: "I want to improve my project's design."
|
||||
- type: transition
|
||||
content: "Processing request..."
|
||||
- type: message
|
||||
from: ai
|
||||
content: "I can definitely help with that. Let's look at the code."
|
||||
+1
-1
@@ -1,7 +1,7 @@
|
||||
{
|
||||
"name": "conversation-replay",
|
||||
"version": "0.1.5",
|
||||
"description": "Create animated conversation demos from YAML for security awareness, IR training, and communication skills education",
|
||||
"description": "Create animated text conversation replays",
|
||||
"main": "dist/cli.js",
|
||||
"type": "module",
|
||||
"bin": {
|
||||
|
||||
Reference in New Issue
Block a user