Skip to content

Add hero GIF and polish README#8

Merged
tig merged 1 commit into
mainfrom
tig/hero-gif-and-readme
May 25, 2026
Merged

Add hero GIF and polish README#8
tig merged 1 commit into
mainfrom
tig/hero-gif-and-readme

Conversation

@tig
Copy link
Copy Markdown
Member

@tig tig commented May 25, 2026

Summary

  • Re-recorded docs/images/hero.gif using tuirec v0.4.0 — shows --help, --json, --cat, and --opencli in a single scrolling terminal frame (~76 KB).
  • Rewrote README for clarity and completeness:
    • Added NuGet + license badges
    • Added a motivating "Why" section
    • Reorganized features into a scannable table
    • Included real JSON output in the quickstart example
    • Added Contributing section pointing to specs/constitution.md
    • General copy tightening throughout

No code changes — documentation only.

- Re-record docs/images/hero.gif using tuirec v0.4.0 with the example app
- Rewrite README for clarity: add badges, a Why section, feature table,
  real JSON output example, contributing pointer, and cleaner structure

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@tig tig merged commit 694dc1c into main May 25, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant