/generate-readme

Description

Create a new README.md from scratch for projects without one

Install

Add the repository(one-time)

/plugin marketplace add bradleyboehmke/brads-marketplace

Install the plugin

/plugin install bradleyboehmke-document-generator-document-generator@bradleyboehmke/brads-marketplace

Prompt Preview

# Generate README

## Activated Agent

**Activate**: `readme-author` agent

The agent will help create a minimal, standards-compliant README for your project.

## Objective

Create a new README.md following the Personal minimal 8-section structure with business context integration and link-first approach.

## Command Parameters

| Parameter | Options | Default | Description |
|-----------|---------|---------|-------------|
| `--tier` | `prototype`, `mvp`, `production` | Auto-detect | Project maturity tier |
| `--format` | `console`, `markdown` | `console` | Output format (console display vs...

Links

GitHub Stats

0 forks

Other plugins with /generate-readme

/generate-readme

Generate comprehensive README.md for the project. Include clear project description and purpose. Document complete tech stack with versions: Next.js, React, TypeScript, Bootstrap, Azure/Railway. List prerequisites and required tools. Provide step-by-step installation instructions. Document all environment variables with descriptions. Explain development workflow: starting dev server, running tests, building for production. Add deployment instructions for Azure Static Web Apps or Railway. Include testing guide with examples. Create contribution guidelines for developers. Add troubleshooting section for common issues. Include license and contact information. Add badges for build status, version, license. Make README clear and maintainable.

larouex-fullstack-builder

/generate-readme

larouex-fullstack-builder

/generate-readme

Use the doc-curator sub-agent to generate comprehensive `README.md` following `TEMPLATE_MODE` standards from `TARGET_FILE` template, ensuring no business-specific references or credentials are included.

documentation-commands

/generate-readme

documentation