Skip to content

docs: add sample JSON output to README #13

@dyoshikawa-claw

Description

@dyoshikawa-claw

Summary

Add a realistic sample JSON event to the README so users can immediately understand the output shape produced by ghactivities.

Suggested content

  • one representative event object
  • brief explanation of important fields
  • optionally mention event type differences if the shape varies by event type

Motivation

The README is much easier to understand when it shows one actual output example, not only CLI flags.

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