Skip to content

Write README with examples and getting started #7

@landigf

Description

@landigf

Context

The README is the first thing people see. It needs to show what ClaudeFlow does in 30 seconds.

Acceptance Criteria

  • One-liner description
  • Install command
  • 10-line "hello world" example
  • Real-world example (bug investigation pipeline)
  • Architecture diagram (text)
  • Link to full docs
  • Badge: tests passing, npm version

Metadata

Metadata

Assignees

No one assigned

    Labels

    P1High prioritydocsDocumentation

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions