Skip to content

README: installation guide, usage examples, and real-world recipes #6

@vmvarela

Description

@vmvarela

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 --help flag (to be added via separate issue if not yet present)

Metadata

Metadata

Assignees

No one assigned

    Labels

    mvpPart of the Minimum Viable Productpriority:highMust be in the next sprintsize:sSmall — 1 to 4 hoursstatus:readyRefined and ready for sprint selectiontype:docsDocumentation only

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions