Skip to content

docs: list supported file formats in README#17

Merged
marksverdhei merged 2 commits into
mainfrom
docs/supported-formats-14
Jun 26, 2026
Merged

docs: list supported file formats in README#17
marksverdhei merged 2 commits into
mainfrom
docs/supported-formats-14

Conversation

@marksverdhai

Copy link
Copy Markdown
Collaborator

Summary

  • Adds a "Supported Formats" section to the README after the Features section
  • Documents text file handling (first 4KB sent to LLM), native image formats (JPEG, PNG, SVG), converted image formats (WebP, BMP, TIFF, GIF via Pillow), and notes that audio/video/other binary files are not supported

Closes #14

Closes #14

Co-Authored-By: marksverdhai <249650165+marksverdhai@users.noreply.github.com>
@marksverdhei

Copy link
Copy Markdown
Owner

Triaged during hivemind sweep. Doc regression — skipping merge:

PR adds: "Audio, video, and other binary files are not supported."

But audio support landed in #20 (merged today, 2026-06-25) and the current README on main already correctly lists audio formats: MP3, WAV, FLAC, OGG, AAC, M4A. Merging this PR would replace accurate content with stale claim.

Suggested: update the PR's table to match #20's audio support before merging, or close + open a new doc PR against current main.

Verified against `hat`:
- Audio (MP3/FLAC/OGG/AAC/WAV/M4A/Opus/WMA/AIFF/APE) is detected
  (`is_audio`, magic bytes + extension) and named from `ffprobe`-extracted
  tags + duration (`collect_metadata` → audio path in `build_user_content`).
  The previous "Audio … not supported" was incorrect.
- Text truncation is `f.read(4000)` (4000 chars), not 4KB.
- Note the ffprobe (audio) / vision-model (image) / EXIF (image) requirements.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@marksverdhei

Copy link
Copy Markdown
Owner

Pushed a correction commit (7dc5256) before merging — verified the doc against hat:

  • Audio is supported. is_audio (hat:76) detects MP3/FLAC/OGG/AAC/WAV/M4A/Opus/WMA/AIFF/APE by magic bytes + extension, and the audio path in build_user_content (hat:159) forwards a prompt that collect_metadata (hat:289) fills from ffprobe tags (title/artist/album/genre/date/track) + duration. The original "Audio … not supported" was inaccurate, so I added an Audio row instead.
  • Text limit is 4000 chars, not 4KB. content = f.read(4000) (hat:165) — tweaked the wording.
  • Added the dependency notes: ffprobe for audio tags, a vision-capable model for images, and that images also fold in EXIF metadata (hat:274).

Everything else in the table matched the code. Squash-merging — thanks @marksverdhai. Closes #14.

@marksverdhei marksverdhei merged commit 93382b3 into main Jun 26, 2026
1 check passed
@marksverdhei marksverdhei deleted the docs/supported-formats-14 branch June 26, 2026 21:26
marksverdhei added a commit that referenced this pull request Jun 27, 2026
Adds (newest first, matching existing style):
- #32 stem-less dotfile guard
- #30 video file support
- #28 --preview / -p flag
- #27 is_audio ftyp false-positive fix
- #20 audio file support

Skipped pure-docs (#15, #16, #17, #31), CI infra (#29), and test-only
rebases (#25) — same selection rule the prior entries used.
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.

List supported file formats in README

2 participants