Skip to content

Write README.md #26

@jdelfino

Description

@jdelfino

Finalize the README.md for the agent-workflow repo.

File

README.md at repo root

What

  • Project name and one-line description
  • Problem statement (agents forget, enforcement > instructions)
  • What you get: 2 commands, automated review, guardrails, auto-merge
  • Quick start: curl | bash + setup.sh
  • How it works: brief overview with examples
  • Configuration reference: config.yaml options, guardrails
  • Commands reference: /plan and /work usage
  • Philosophy: structural enforcement, human escalation, one-session tasks

Note

Initial README already exists from bootstrap. This task refines it after all content is written.

Metadata

Metadata

Assignees

No one assigned

    Labels

    taskImplementation work item

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions