convez.ai
SkillDesenvolvimento WebIntermediário
ChanMeng666

Readme Showcase

ChanMeng666/readme-showcase

Captura automática de screenshots e demos para READMEs GitHub

Ver no GitHub
BomPluginScore · de 0 a 100

Skill para Claude Code que captura screenshots polidos e GIFs de demonstração de projetos web implantados, automatizando sua inserção em READMEs do GitHub. Utiliza Playwright para captura headless, ffmpeg para processamento de mídia e arquivos de cenário reutilizáveis.

Instalação

$npx convez-ai ChanMeng666/readme-showcase

1 comando no terminal: detecta o formato do repositório (marketplace ou plugin avulso) e instala via Claude Code. Requer Node 18+ e o Claude Code instalado.

Métricas

Estrelas
1
Forks
0
Acompanhando
1
Saúde
100%
Último commit
há 1 semana
Versão
v0.2.0
Issues abertas
0
Contribuidores
1

Casos de uso

  • Gerar showcases visuais automáticos para projetos web
  • Atualizar READMEs com screenshots e GIFs de demonstração
  • Documentar interações de aplicações através de captures reproduzíveis

Veredito

Solução prática e bem arquitetada para documentação visual de projetos. Destaca-se pela abordagem de cenários reutilizáveis e processamento inteligente de mídia com fallbacks, mas exige conhecimento técnico (Node, Playwright, ffmpeg) para setup inicial.

README

A tradução para o português deste README ainda está na fila.

readme-showcase

A Claude Code skill that captures polished screenshots and a short demo recording of any deployed web project, then embeds them into that project's GitHub README — so visitors see the real product without opening the live link.

"add a showcase to gradient-svg-generator's README"
        │
        ▼
probe the live site ──► write showcase.scenario.json ──► capture ──► encode ──► README block
   (survey + shots)        (committed to the repo,        Playwright   ffmpeg     idempotent
                            reproducible, diffable)       headless     GIF/MP4/    markers
                                                          shots+video  WebP

What you get per project

FileWhat it is
docs/showcase/hero.webp2× desktop hero shot, linked to the live site
docs/showcase/*-full.webpfull-page / inner-page shots
docs/showcase/mobile-*.webp3× mobile shot
docs/showcase/demo.gif≤ 7.5 MB interaction demo — the only video format GitHub READMEs auto-play
docs/showcase/demo.mp4same demo, higher quality, for manual drag-upload into releases/comments
docs/showcase/showcase.scenario.jsonthe capture script itself — edit + re-run to refresh

The README gets an idempotent <!-- SHOWCASE:START/END --> block: re-running the skill replaces the block contents instead of duplicating them.

Design choices

  • Headless Playwright, not OS screen capture — clean frames (no cursor, taskbar, or notifications), deterministic viewports, device scaling, and native context-level video recording.
  • Scenario file committed to the target repo — captures are reproducible state snapshots, not one-off artifacts.
  • GIF quality ladder — two-pass palette encoding stepped down (fps/width/colors/dither) until the file fits under GitHub's render cap; if the bottom rung doesn't fit, the fix is a shorter demo, not a muddier GIF.
  • Human review gate — the skill always stops to show assets + README diff before committing, and never pushes on its own.
  • Zero install in target repos — playwright-core is resolved from your machine (local dep → PLAYWRIGHT_CORE_PATH → global npm root) and the newest cached Chromium build is discovered dynamically.

Requirements

  • Claude Code
  • Node 18+
  • Playwright in some form (npm i -g @playwright/cli + playwright install chromium is enough)
  • ffmpeg on PATH
  • optional: sharp-cli for slightly better WebP encoding (falls back to ffmpeg)

Install

git clone https://github.com/ChanMeng666/readme-showcase.git
# symlink (or copy) into your personal skills directory:
#   macOS/Linux
ln -s "$(pwd)/readme-showcase" ~/.claude/skills/readme-showcase
#   Windows (PowerShell)
New-Item -ItemType SymbolicLink -Path "$env:USERPROFILE\.claude\skills\readme-showcase" -Target "D:\path\to\readme-showcase"

Then ask Claude Code things like:

  • "add screenshots and a demo GIF to my-project's README"
  • "showcase https://my-app.vercel.app in ~/code/my-app"
  • "refresh the showcase for my-project" (after a redesign)

Repo layout

SKILL.md                    workflow Claude follows (the skill itself)
scripts/probe.mjs           survey a live URL → survey.json + probe shots
scripts/capture.mjs         scenario engine → PNG shots + webm recording
scripts/media.mjs           ffmpeg/sharp → WebP + MP4 + size-capped GIF
scripts/lib/browser.mjs     playwright-core + Chromium discovery
scripts/lib/actions.mjs     the 6-action scenario interpreter
references/                 schema, README block templates, troubleshooting
examples/                   a real scenario from the pilot project

Scenario format

Six actions — goto, click, fill, scroll, hover, wait — plus per-page viewport/fullPage settings. See references/scenario-schema.md and the pilot example.

License

MIT © Chan Meng

Ver o original no GitHub

Bom para

Relacionados