📜 Nirvana README Architect (NRA)

Squad (Squad Protocol v5) that generates the perfect README.md for any project — combining deep codebase analysis, intelligent template selection, all GitHub Flavored Markdown features, 25+ point checklist validation, and final polishing.

Table of Contents

• Overview
• Agents
• Pipeline
• Getting Started
• Commands
• Architecture
• Supported GitHub Features
• Quality Checklist
• Troubleshooting
• Contributing
• License

Overview

Nirvana README Architect is a squad of 5 specialized agents that work in a pipeline to transform any codebase into a professional-grade README.

Unlike simple generators that produce generic templates, NRA:

• Analyzes the actual codebase (tech stack, scripts, env vars, directory structure)
• Selects the ideal template by project type (Library, CLI, Web App, API, Monorepo, Mobile, Squad)
• Generates content using all GitHub Flavored Markdown features
• Validates with a 25+ point checklist and automatic scoring
• Polishes with badges, TOC, collapsed sections, and perfect spacing

Agents

Pipeline

Getting Started

1. Clone the repository

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

2. Install as squad

Copy the directory to your project's

squads/

squads install gutomec/nirvana-readme-architect

3. Use the squad

# Activate the orchestrator
@nra-orchestrator

# Generate full README
*readme {project-path}

# Or quick mode (6 essential sections)
*readme-quick

Commands

Architecture

nirvana-readme-architect/
├── agents/                          # 5 specialized agents
├── tasks/                           # 7 executable tasks
├── workflows/
│   └── readme-generation-pipeline.yaml
├── checklists/
│   └── readme-quality.md            # 25+ validation points
├── templates/
│   └── nirvana-readme.md            # Master template with GFM features
├── config/                          # Standards and tech stack
├── squad.yaml                       # Squad manifest
└── README.md

Supported GitHub Features

Quality Checklist

Troubleshooting

Contributing

Contributions are welcome! Follow Conventional Commits for commit messages.

License

This project is licensed under the MIT License — see the LICENSE file for details.