Skip to content

docs(readme): rewrite README in the target-gc format - #2

Open
decebal wants to merge 1 commit into
mainfrom
docs/readme
Open

decebal wants to merge 1 commit into
mainfrom
docs/readme

Conversation

@decebal

@decebal decebal commented Oct 7, 2026

Copy link
Copy Markdown
Contributor

Summary

Rewrote README.md to follow the target-gc reference format:

  • Centered header with bold tagline and outcome statement
  • Badges for CI, license, TypeScript, Next.js, Bun
  • Skillicons row showing actual tech stack
  • Problem paragraph: SaaS template configuration burden and missing integrated infrastructure
  • Note about Midday V1 upstream and TanStack Query enhancement
  • Summary table: frontend, backend, state management, auth, email, jobs, monitoring, testing capabilities
  • Install section: template scaffold and setup commands
  • What it does: table of capabilities with real examples (Supabase auth, TanStack Query, Resend, Trigger.dev, etc.)
  • Architecture: directory tree showing apps, packages (analytics, email, jobs, kv, logger, react-query, supabase, ui), tooling
  • Why not existing tools: comparison with Create T3 App, create-next-app, Firebase, Wasp, Blitz, and upstream Midday V1
  • Limits: Bun-only, Docker requirement for local Supabase, ElysiaJS backend architecture, no Rust, Playwright tests, third-party keys
  • License: MIT with original Midday Labs copyright

Sources

  • docs/README.md: documentation index and overview
  • docs/guides/GETTING_STARTED.md: setup instructions
  • docs/current/ARCHITECTURE.md: system design and patterns
  • docs/current/MONOREPO_STRUCTURE.md: structure documentation
  • LICENSE.md: copyright and MIT license
  • .clauderc and .mcp.json: Claude Code integration references (kept)

Left out

  • Individual feature descriptions beyond the summary table (available in full docs)
  • Contributing guide link (not part of target-gc format)
  • Custom footer with creator attribution (not standard format)
  • Package structure enumeration (condensed to table and tree)
  • Prerequisites section (condensed to key requirements)

🤖 Generated with Claude Code

Restructured README following target-gc format:
- Header: centered name, bold tagline, outcome statement, badges, skillicons
- Problem: SaaS template configuration and missing infrastructure
- Summary table: frontend, backend, state management, auth, email, jobs, monitoring, testing
- Install: template scaffold and setup commands
- What it does: table of capabilities with examples
- Architecture: directory tree of apps, packages, and tooling
- Why not existing tools: comparison with T3, Firebase, Wasp, Blitz, Midday V1
- Limits: Bun-only runtime, Docker requirement, ElysiaJS backend, no Rust, Playwright tests
- License: MIT with Midday Labs copyright

Sources: docs/README.md, docs/guides/GETTING_STARTED.md, docs/current/ARCHITECTURE.md, LICENSE.md
Kept: MCP documentation references (.clauderc, .mcp.json pointers)

@greptile-apps greptile-apps Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Your trial has ended. Reactivate Greptile to resume code reviews.

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