Overview
The Partiful CLI README needs a major glow-up. Currently functional but doesn't showcase the tool well.
Proposed Structure
- Hero section — Logo/banner, one-liner, badges (version, license, npm downloads)
- Quick start — 3 commands: install → auth → first event
- Feature grid — Visual showcase of capabilities (events, guests, blasts, contacts, posters, templates, bulk, watch)
- Terminal demos — GIF recordings of key flows:
- Create an event with a poster
- Search contacts and invite by name
- Send a text blast
- Export guest list
- Agent integration — Section showing how AI agents use the CLI (OpenClaw, Claude Code)
- Architecture overview — Brief diagram of how it interfaces with Partiful
- Full command reference — Generated from
partiful schema
Inspiration
Overview
The Partiful CLI README needs a major glow-up. Currently functional but doesn't showcase the tool well.
Proposed Structure
partiful schemaInspiration