-
Notifications
You must be signed in to change notification settings - Fork 0
Closed
Labels
mvpPart of the Minimum Viable ProductPart of the Minimum Viable Productpriority:highMust be in the next sprintMust be in the next sprintsize:sSmall — 1 to 4 hoursSmall — 1 to 4 hoursstatus:readyRefined and ready for sprint selectionRefined and ready for sprint selectiontype:docsDocumentation onlyDocumentation only
Milestone
Description
Description
The current README is a one-liner. Users need installation instructions, usage examples, and common recipes so they can adopt the tool quickly.
Acceptance Criteria
- Installation section: download binary, or
brew install(if published), or build from source - Basic usage:
echo 'name,age\nAlice,30' | sql-pipe 'SELECT * FROM t' - At least 5 real-world usage examples (filter, aggregate, join with multiple tables if supported, etc.)
- Documents the input format requirements (CSV with header row, table name
t) - Documents exit codes and error messages
- Badges: build status, latest release, license
Notes
- Keep examples copy-pasteable and self-contained
- Mention
--helpflag (to be added via separate issue if not yet present)
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
mvpPart of the Minimum Viable ProductPart of the Minimum Viable Productpriority:highMust be in the next sprintMust be in the next sprintsize:sSmall — 1 to 4 hoursSmall — 1 to 4 hoursstatus:readyRefined and ready for sprint selectionRefined and ready for sprint selectiontype:docsDocumentation onlyDocumentation only