UX-006: Better Getting Started Experience

[ajitpratap0]

Summary

Rewrite README Quick Start to reduce time-to-first-success from 30 minutes to under 5 minutes.

Problem

README Quick Start is too complex for beginners - shows low-level pool management instead of simple API.

Action Items

1. Rewrite README Quick Start section:

   • Use simple gosqlx.Parse() API (not tokenizer → parser)
   • Show 5-line working example
   • Progressive disclosure (advanced features later)
   • Remove pool management from first example

2. Add "Hello World" minimal example:

   package main
   import "github.com/ajitpratap0/GoSQLX/pkg/gosqlx"
   
   func main() {
       ast, _ := gosqlx.Parse("SELECT * FROM users")
       println("Parsed successfully!")
   }

3. Create three-tier structure:

   • Quick Start (5 lines, < 2 min)
   • Basic Usage (10-20 lines, < 5 min)
   • Advanced Usage (link to GETTING_STARTED.md)

4. Link to GETTING_STARTED.md for full tutorial

5. Add video walkthrough (optional, 2-3 minutes)

Acceptance Criteria

• README Quick Start uses simple API (not tokenizer/parser)
• Working example in < 10 lines
• Time-to-first-success < 5 minutes (user tested)
• Progressive disclosure structure
• User testing validates improvement

Technical Details

Priority: High
Effort: Small (4h)
Phase: Phase 3 - UX & Documentation
Dependencies: UX-001 (Simplified API)

Success Metric

User can copy/paste example and see working code in < 5 minutes