markupr 2.4.0 → 2.5.0

package/README.md

@@ -1,3 +1,9 @@
+> **This project has moved.** FeedbackFlow has been rebranded and evolved into **[markupr](https://github.com/eddiesanjuan/markupr)** -- with cross-platform support, a CLI, an MCP server for AI coding agents, and an intelligent post-processing pipeline. All future development happens at [github.com/eddiesanjuan/markupr](https://github.com/eddiesanjuan/markupr).
+>
+> **Install:** `npm install -g markupr` | **Download:** [markupr.com](https://markupr.com) | **Releases:** [github.com/eddiesanjuan/markupr/releases](https://github.com/eddiesanjuan/markupr/releases)
+
+---
+
 <p align="center">
   <img src="src/renderer/assets/logo.svg" alt="markupr Logo" width="120" height="120">
 </p>
@@ -23,6 +29,7 @@
   <a href="#why-markupr">Why markupr?</a> |
   <a href="#features">Features</a> |
   <a href="#how-it-works">How It Works</a> |
+  <a href="#example-output">Examples</a> |
   <a href="#installation">Installation</a> |
   <a href="#cli-usage">CLI Usage</a> |
   <a href="#mcp-server-for-ai-coding-agents">MCP Server</a> |
@@ -170,6 +177,14 @@ idle ─→ starting (5s timeout) ─→ recording (30min max) ─→ stopping (
 
 Every state has a maximum duration. A watchdog timer monitors state age and forces recovery if anything gets stuck.
 
+## Example Output
+
+See what markupr produces:
+
+- [Desktop app feedback session](examples/feedback-session-example.md) -- a developer reviewing a dashboard, finding mobile and UX issues
+- [MCP server capture session](examples/mcp-session-example.md) -- an AI coding agent recording a CSS bug via `capture_with_voice`
+- [CLI analysis output](examples/cli-output-example.md) -- `npx markupr analyze` processing a security code review
+
 ## Installation
 
 ### macOS
@@ -276,6 +291,7 @@ Process a screen recording into a structured Markdown document with extracted fr
 | `--output <dir>` | Output directory | `./markupr-output` |
 | `--whisper-model <path>` | Path to local Whisper model file | Auto-detected in `~/.markupr/whisper-models/` |
 | `--no-frames` | Skip frame extraction | `false` |
+| `--template <name>` | Output template (`markdown`, `json`, `github-issue`, `linear`, `jira`, `html`) | `markdown` |
 | `--verbose` | Show detailed progress output | `false` |
 
 **Examples:**
@@ -294,6 +310,86 @@ markupr analyze ./screen.mov --audio ./voiceover.wav
 markupr analyze ./recording.mov --no-frames
 ```
 
+#### `markupr watch [directory]`
+
+Watch a directory for new screen recordings and auto-process them as they appear. Ideal for continuous feedback workflows.
+
+```bash
+# Watch the current directory
+markupr watch
+
+# Watch a specific directory with custom output
+markupr watch ./recordings --output ./reports
+
+# Watch with verbose logging
+markupr watch ~/Desktop --verbose
+```
+
+#### `markupr push github <report>`
+
+Create GitHub issues from a markupr feedback report. Each feedback item (FB-001, FB-002, etc.) becomes a separate issue with labels and structured markdown.
+
+```bash
+# Create issues from a report (uses gh CLI auth or GITHUB_TOKEN)
+markupr push github ./markupr-output/report.md --repo myorg/myapp
+
+# Preview what would be created
+markupr push github ./report.md --repo myorg/myapp --dry-run
+
+# Push specific items only
+markupr push github ./report.md --repo myorg/myapp --items FB-001 FB-003
+```
+
+Authentication resolves in order: `--token` flag, `GITHUB_TOKEN` env var, `gh auth token` CLI.
+
+#### `markupr push linear <report>`
+
+Create Linear issues from a markupr feedback report.
+
+```bash
+# Create issues in a Linear team
+markupr push linear ./report.md --team ENG
+
+# Assign to a project with dry run
+markupr push linear ./report.md --team DES --project "Q1 Polish" --dry-run
+```
+
+Set `LINEAR_API_KEY` env var or pass `--token`.
+
+### Output Templates
+
+markupr supports multiple output templates for the `analyze` command:
+
+| Template | Description |
+|----------|-------------|
+| `markdown` | Default structured Markdown (llms.txt-inspired) |
+| `json` | Machine-readable JSON for integrations |
+| `github-issue` | GitHub-flavored Markdown optimized for issues |
+| `linear` | Linear-optimized issue format |
+| `jira` | Jira-compatible markup |
+| `html` | Self-contained HTML document |
+
+```bash
+# Generate JSON output for automation
+markupr analyze ./recording.mov --template json
+
+# Generate GitHub-ready issue format
+markupr analyze ./recording.mov --template github-issue
+```
+
+### GitHub Action
+
+Run markupr in CI to get visual feedback on pull requests. Add the action to your workflow:
+
+```yaml
+- uses: eddiesanjuan/markupr-action@v1
+  with:
+    video-path: ./test-recording.mov
+    output-dir: ./markupr-output
+```
+
+See [markupr-action/README.md](markupr-action/README.md) for full configuration options.
+
 ### Requirements
 
 - **Node.js** 18+