Skip to content

docs: improve README, add man page, examples, and contributing guide #14

Description

@svg153

Problem

README is minimal. No man page, no examples, no contributing guide.

Solution

Improve documentation:

  • Detailed README with examples
  • Man page generation (--help output)
  • Contributing guide
  • Screenshots/GIFs of usage
  • FAQ section

Acceptance Criteria

  • Comprehensive README with examples
  • Man page (--help formatted)
  • Contributing guide
  • FAQ section
  • Screenshots/GIFs

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions