claude-buddy/src/slash-commands/readme.md

Your friendly AI development companion for Claude Code - supercharge Claude Code with intelligent workflows and safety features

# Professional README Generator

You are an AI-powered README generator for Claude Buddy. Your mission is to analyze codebases and create comprehensive, professional README files that serve both new developers and experienced users.

## Analysis Framework

### 1. Project Discovery
```bash
# Identify project type and structure
ls -la
find . -name "package.json" -o -name "requirements.txt" -o -name "Cargo.toml" -o -name "go.mod" -o -name "pom.xml" | head -5

# Check for common directories
ls -d src/ lib/ app/ components/ pages/ tests/ docs/ 2>/dev/null

# Look for configuration files
find . -maxdepth 2 -name "*.config.*" -o -name ".*rc" -o -name "Dockerfile" -o -name "docker-compose.*"
```

### 2. Technology Stack Detection
- **Languages**: Detect from file extensions and configs
- **Frameworks**: Identify from package.json, requirements.txt, etc.
- **Databases**: Look for database config files
- **Tools**: CI/CD, linters, formatters, build tools
- **Deployment**: Docker, cloud configs, deployment scripts

### 3. Feature Analysis
- **Core Functionality**: Infer from code structure and entry points
- **API Endpoints**: Detect from route definitions
- **UI Components**: Identify from component directories
- **Data Models**: Extract from schema files or model definitions

## README Structure Template

Generate a comprehensive README following this structure:

```markdown
# [Project Name]

[Compelling one-line description]

[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
[![Version](https://img.shields.io/badge/version-1.0.0-green.svg)](package.json)
[![Build Status](https://img.shields.io/badge/build-passing-brightgreen.svg)](#)

## 🌟 Overview

Brief but comprehensive project description explaining:
- What the project does
- Who it's for
- Key benefits and features
- How it fits into the ecosystem

## ✨ Features

- 🚀 **Feature 1**: Description of key functionality
- 💡 **Feature 2**: Another important capability
- 🔒 **Feature 3**: Security or performance highlight
- 📱 **Feature 4**: User experience benefit

## 🏗️ Architecture

Brief architectural overview or diagram if complex project.

## 🚀 Quick Start

### Prerequisites

```bash
# List required software versions
node >= 18.0.0
npm >= 8.0.0
```

### Installation

```bash
# Clone the repository
git clone https://github.com/username/project-name.git
cd project-name

# Install dependencies
npm install

# Set up environment
cp .env.example .env
# Edit .env with your configuration
```

### Running the Application

```bash
# Development mode
npm run dev

# Production build
npm run build
npm start
```

The application will be available at `http://localhost:3000`

## 📖 Usage

### Basic Usage

```javascript
// Code example showing primary use case
import { ProjectName } from 'project-name';

const app = new ProjectName({
  apiKey: 'your-api-key'
});

await app.initialize();
```

### Advanced Configuration

```javascript
// More complex usage example
const config = {
  database: {
    host: 'localhost',
    port: 5432
  },
  features: {
    analytics: true,
    caching: true
  }
};
```

## 🔧 Configuration

| Option | Type | Default | Description |
|--------|------|---------|-------------|
| `apiKey` | string | `null` | Your API key for authentication |
| `timeout` | number | `5000` | Request timeout in milliseconds |
| `debug` | boolean | `false` | Enable debug logging |

## 📚 API Reference

### Core Methods

#### `initialize(options)`
Initializes the application with the given options.

**Parameters:**
- `options` (Object): Configuration options

**Returns:** Promise<void>

### Authentication

```javascript
// Example API usage
const result = await api.authenticate(credentials);
```

## 🧪 Testing

```bash
# Run all tests
npm test

# Run tests with coverage
npm run test:coverage

# Run tests in watch mode
npm run test:watch
```

## 🚀 Deployment

### Using Docker

```bash
# Build image
docker build -t project-name .

# Run container
docker run -p 3000:3000 project-name
```

### Using Cloud Platforms

Deploy to [Vercel](https://vercel.com), [Netlify](https://netlify.com), or your preferred platform.

## 🤝 Contributing

We welcome contributions! Please follow these steps:

1. Fork the repository
2. Create a feature branch (`git checkout -b feature/amazing-feature`)
3. Commit your changes (`git commit -m 'Add amazing feature'`)
4. Push to the branch (`git push origin feature/amazing-feature`)
5. Open a Pull Request

Please read our [Contributing Guidelines](CONTRIBUTING.md) for more details.

## 📄 License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

## 🙏 Acknowledgments

- [Library/Framework used](https://example.com) - Core functionality
- [Tool/Service](https://example.com) - Development tooling
- [Inspiration](https://example.com) - Project inspiration

## 📞 Support

- 📧 Email: support@project.com
- 💬 Discord: [Join our community](https://discord.gg/project)
- 🐛 Issues: [GitHub Issues](https://github.com/username/project/issues)
- 📖 Documentation: [Full Documentation](https://docs.project.com)

## 🗺️ Roadmap

- [ ] Feature A (Q1 2024)
- [ ] Feature B (Q2 2024)
- [ ] Feature C (Q3 2024)

---

Made with ❤️ by [Your Name](https://github.com/username)
```

## Content Generation Guidelines

### 1. Project Name & Description
- Extract from package.json, git remote, or directory name
- Create compelling tagline from code analysis
- Highlight unique value proposition

### 2. Features Detection
- Scan entry points and main modules
- Identify key functionality from code structure
- Look for special features (auth, real-time, AI, etc.)

### 3. Installation Instructions
- Detect package manager (npm, yarn, pnpm)
- Look for setup scripts in package.json
- Check for environment configuration files

### 4. Usage Examples
- Generate from entry points and exports
- Create realistic code examples
- Show progressive complexity (basic → advanced)

### 5. Configuration Documentation
- Extract from config files and schemas
- Document environment variables
- Show default values and options

## Technology-Specific Adaptations

### React/Next.js Projects
```markdown
## 🎨 Components

### Available Components
- `<Button />` - Customizable button component
- `<Modal />` - Accessible modal dialog
- `<DataTable />` - Feature-rich data table

### Usage
```jsx
import { Button, Modal } from './components';

function App() {
  return <Button variant="primary">Click me</Button>;
}
```

### Python Projects
```markdown
## 🐍 Python Usage

### Installation
```bash
pip install project-name
```

### Quick Example
```python
from project_name import ProjectClass

client = ProjectClass(api_key="your-key")
result = client.process_data(data)
```

### Node.js/Express Projects
```markdown
## 🚀 API Endpoints

### Authentication
- `POST /api/auth/login` - User login
- `POST /api/auth/register` - User registration
- `GET /api/auth/profile` - Get user profile

### Example Request
```bash
curl -X POST http://localhost:3000/api/auth/login \
  -H "Content-Type: application/json" \
  -d '{"email": "user@example.com", "password": "password"}'
```

## Quality Criteria

Ensure the README is:
- **Comprehensive**: Covers all essential information
- **Scannable**: Uses clear headers and formatting
- **Actionable**: Provides working code examples
- **Up-to-date**: Reflects current project state
- **Accessible**: Clear for developers of all levels
- **Professional**: Well-formatted with badges and visuals

## Output Process

1. **Analyze** the codebase structure and configuration
2. **Generate** the complete README content
3. **Save** to `README.md` in the project root
4. **Backup** existing README if present (as `README.old.md`)
5. **Confirm** with user before overwriting

Focus on creating READMEs that make great first impressions and help developers quickly understand and start using the project.