📜 Nirvana README Architect (NRA)

Squad (Squad Protocol v5) que genera el README.md perfecto para cualquier proyecto — combina análisis profundo del codebase, selección inteligente de plantillas, todas las funcionalidades de GitHub Flavored Markdown, validación con checklist de 25+ puntos y pulido final.

Índice

• Visión General
• Agentes
• Pipeline
• Primeros Pasos
• Comandos
• Arquitectura
• Features GitHub Soportadas
• Checklist de Calidad
• Solución de Problemas
• Contribuir
• Licencia

Visión General

Nirvana README Architect es un squad de 5 agentes especializados que trabajan en pipeline para transformar cualquier codebase en un README de nivel profesional.

A diferencia de generadores simples que producen plantillas genéricas, NRA:

• Analiza el codebase real (tech stack, scripts, variables de entorno, estructura de directorios)
• Selecciona la plantilla ideal por tipo de proyecto (Library, CLI, Web App, API, Monorepo, Mobile, Squad)
• Genera contenido usando todas las features de GitHub Flavored Markdown
• Valida con checklist de 25+ puntos y scoring automático
• Pule con badges, TOC, secciones colapsables y espaciado perfecto

Agentes

Pipeline

Primeros Pasos

# Clonar
git clone https://github.com/gutomec/nirvana-readme-architect.git

# Instalar como squad
squads install gutomec/nirvana-readme-architect

# Usar
@nra-orchestrator
*readme {ruta-del-proyecto}

Comandos

Arquitectura

nirvana-readme-architect/
├── agents/          # 5 agentes especializados
├── tasks/           # 7 tareas ejecutables
├── workflows/       # Pipeline de generación
├── checklists/      # 25+ puntos de validación
├── templates/       # Plantilla master con GFM
├── config/          # Estándares y tech stack
└── squad.yaml       # Manifiesto del squad

Features GitHub Soportadas

Alerts, Mermaid Diagrams, Tables, Collapsed Sections, Task Lists, Footnotes, Badges (shields.io), Emojis, kbd Tags, Code Blocks, Diff Blocks, Reference Links — 12 features completas.

Checklist de Calidad

Solución de Problemas

Contribuir

Las contribuciones son bienvenidas. Siga Conventional Commits para mensajes de commit.

Licencia

Licenciado bajo MIT — ver LICENSE.