@jmkim85/dev-flow-mcp/templates/readme_template.md

MCP-based Dev Flow - AI-powered development workflow management with 13 essential tools for TDD and context management

# [Project Name]

> [Brief project description in one sentence]

## Overview

[Detailed description of what this project does, its purpose, and key benefits]

## Features

- ✅ [Feature 1]
- ✅ [Feature 2]
- ✅ [Feature 3]
- 🚧 [Feature in progress]
- 📋 [Planned feature]

## Installation

### Prerequisites

- [Required software/tools]
- [Minimum versions]

### Quick Start

```bash
# Clone the repository
git clone [repository-url]
cd [project-directory]

# Install dependencies
[installation command]

# Run tests
[test command]

# Start development
[development command]
```

## Usage

### Basic Example

```[language]
// Basic usage example
[code example]
```

### Advanced Usage

```[language]
// More complex example
[code example]
```

## Development

This project uses **Dev Flow MCP** for development workflow management with strict TDD practices.

### Development Workflow

1. **Analyze**: Understand requirements and plan approach
2. **Write Tests**: Create failing tests first
3. **Implement**: Write minimal code to pass tests
4. **Refactor**: Improve code while keeping tests green

### Getting Started with Development

```bash
# Initialize Dev Flow (if not already done)
devflow init

# Check current status
devflow status

# Get next task to work on
# Use MCP tool: get_next_task

# Start working on a task
# Use MCP tool: start_task with task_id and stage

# Load TDD workflow for guidance
# Use MCP tool: load_workflow with workflow_id "tdd_strict"
```

### Running Tests

```bash
# Run all tests
[test command]

# Run specific test file
[specific test command]

# Run tests with coverage
[coverage command]
```

### Project Structure

```
project-root/
├── src/                 # Source code
├── tests/              # Test files
├── docs/               # Documentation
├── .devflow/           # Dev Flow configuration
│   ├── tasks.yaml      # Task definitions
│   ├── state.json      # Current development state
│   └── workflows/      # Custom workflows
├── package.json        # Dependencies (Node.js)
├── requirements.txt    # Dependencies (Python)
├── Cargo.toml         # Dependencies (Rust)
└── README.md          # This file
```

## API Reference

### [Main Class/Module]

#### Methods

- `method1(param)`: [Description]
- `method2(param)`: [Description]

### [Secondary Class/Module]

#### Methods

- `method1(param)`: [Description]

## Contributing

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

### Development Guidelines

- Follow TDD principles strictly
- Write tests before implementation
- Ensure all tests pass before committing
- Use meaningful commit messages
- Update documentation as needed

## Testing

- **Unit Tests**: [Description and location]
- **Integration Tests**: [Description and location]
- **End-to-End Tests**: [Description and location]

### Test Coverage

Current test coverage: [X]%

Target coverage: 80%+

## License

[License information]

## Support

- 📧 Email: [contact email]
- 🐛 Issues: [GitHub issues link]
- 📖 Documentation: [documentation link]

## Changelog

### [Version] - [Date]
- [Change description]

### [Previous Version] - [Date]
- [Change description]

---

*This README was generated using Dev Flow MCP templates. Customize it for your specific project needs.*