Skip to content

Improve README for HN launch#8

Merged
George-iam merged 1 commit intomainfrom
fix/readme-improvements-20260325
Mar 25, 2026
Merged

Improve README for HN launch#8
George-iam merged 1 commit intomainfrom
fix/readme-improvements-20260325

Conversation

@George-iam
Copy link
Contributor

Summary

  • Add before/after code comparison right after "What Is AXME?" - shows ~15 lines of polling/webhook/Redis glue vs ~3 lines with AXME
  • Add human task types table (8 types: approval, form, review, override, confirmation, assignment, clarification, manual_action)
  • Add internal runtime steps table (6 steps: human_approval, timeout, reminder, delay, escalation, notification)
  • Collapse Repository Map, SDKs install table, and Contributing sections into <details> tags to reduce scroll length

Test plan

  • Verify README renders correctly on GitHub (tables, code blocks, collapsible sections)
  • Confirm all existing links still work
  • Check that collapsible sections expand/collapse properly

…es, collapsible sections

Add before/after code comparison showing polling+webhooks vs AXME (3 lines).
Add human task types table (8 types) and internal runtime steps table (6 steps).
Collapse Repository Map, SDKs install table, and Contributing into <details> tags.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@George-iam George-iam merged commit 754ccb5 into main Mar 25, 2026
1 check passed
@George-iam George-iam deleted the fix/readme-improvements-20260325 branch March 25, 2026 13:30
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