Skip to content

Add README.md to repository root #38

@ldraney

Description

@ldraney

The project has no README.md, which is the first thing visitors see on GitHub.

What it should include

  • Project tagline / one-liner
  • What dev-sop-engine does (define config in sop.json, generate .claude/ and .mcp.json)
  • Quick start (npx dev-sop-engine .)
  • Link to GitHub Pages docs site
  • Minimal sop.json example
  • Link to CLAUDE.md for full schema reference
  • Badge(s) if applicable (license, npm version once published)

Context

  • CLAUDE.md already has comprehensive technical docs — README should complement, not duplicate
  • GitHub Pages site exists at docs/ with architecture, roadmap, user stories
  • No LICENSE file yet either (separate concern)

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions