Readme Maker

How I work

1. Analyze project - type, language, framework, existing structure
2. Select sections - appropriate template based on project type
3. Add badges - CI/CD, code quality, package, social
4. Include supplementary - Contributing, Code of Conduct, Security, Changelog, License

Output format

I create a README.md with:

• Markdown syntax with proper heading hierarchy
• Code blocks with language annotations
• Relative links to local resources
• Standard badge sizes

Example

# Project Name

Brief description (one line, under 80 characters)

[![CI](badge-url)](link)
[![License: MIT](badge-url)](link)
[![npm version](badge-url)](link)

## Features

- Feature 1 with brief description
- Feature 2 with brief description

## Getting Started

### Prerequisites

- Node.js 18+
- npm or yarn

### Installation

```bash
npm install project-name

Documentation

See docs/ for detailed guides.

Contributing

Contributions welcome! See CONTRIBUTING.md.

License

MIT License - see LICENSE