Modernize README with AI-native positioning

Summary

Modernize the README to be more attractive for AI-focused developers, inspired by timescale/pg-aiguide.

Goals

  • Concise, scannable structure (~120 lines vs ~430)
  • AI-native positioning — "built for humans and AI agents"
  • Quick start focused on pgai checkup (no Docker required)
  • Full monitoring stack as secondary option
  • MCP server integration documentation
  • CLI + LLM piping examples
  • Production-safe section with --print-sql audit feature
  • Screencast demo concept (Claude Code troubleshooting)

Changes

README

  • Centered header with modern badges (npm, license, PostgreSQL)
  • "Why postgres_ai?" value proposition
  • Quick start: npx pgai checkup postgresql://...
  • Full monitoring stack section (Docker-based)
  • "For AI developers" section with MCP and LLM examples
  • Production-safe section highlighting --print-sql
  • Updated counts: 13+ dashboards, 45+ metrics

CLI Enhancement

  • Support positional check ID: pgai checkup H002 postgresql://...
  • In addition to: pgai checkup --check-id H002 postgresql://...

Assets

  • New optimized logo (77K vs 456K)
  • Screencast demo plan document

Related

  • Supersedes approach from #90 (streamlined README)
  • Inspired by https://github.com/timescale/pg-aiguide
Assignee Loading
Time tracking Loading