Skip to content

Docs: Rewrite README for product-led structure#482

Merged
FL4TLiN3 merged 1 commit intomainfrom
docs/rewrite-readme
Feb 12, 2026
Merged

Docs: Rewrite README for product-led structure#482
FL4TLiN3 merged 1 commit intomainfrom
docs/rewrite-readme

Conversation

@FL4TLiN3
Copy link
Contributor

Summary

  • Restructure README around product components: Key Features → Quick Start → Deployment → Why Perstack
  • Add Deployment section with lockfile (perstack install), Dockerfile, and programmatic API examples
  • Replace prose-heavy "Why Perstack?" with problem-solution table
  • Fix code examples to match actual API signatures (run() two-arg form, eventListener in options)
  • Update Key Features bullets to outcome-based descriptions
  • Add multi-provider support mention (8 LLM providers)

Test plan

  • Verify all links resolve correctly
  • Verify code examples match actual CLI and runtime API

🤖 Generated with Claude Code

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@FL4TLiN3 FL4TLiN3 merged commit a601894 into main Feb 12, 2026
9 checks passed
@FL4TLiN3 FL4TLiN3 deleted the docs/rewrite-readme branch February 12, 2026 08:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant