Skip to content

docs: use the Format constants in the README convert examples - #31

Merged
Sreini merged 1 commit into
masterfrom
docs/format-readme
Nov 4, 2026
Merged

Sreini merged 1 commit into
masterfrom
docs/format-readme

Conversation

@Sreini

@Sreini Sreini commented Nov 4, 2026

Copy link
Copy Markdown
Contributor

The convert examples in the README passed raw media-type strings, so the Format constants added in 1.8.0 (#28) appeared nowhere in the README.

  • The two Format Conversion examples now use tinify.Format.WEBP / tinify.Format.AVIF / tinify.Format.JXL, with the full set listed in a comment.
  • A line notes the constants are plain strings, so type="image/webp" keeps working — nothing here is a behaviour change.
  • The tagline and feature list mention JPEG XL alongside the other convert targets.

Documentation only; no code or version change.

🤖 Generated with Claude Code

The convert examples passed raw media-type strings, so nothing in the
README pointed at the constants this release adds. They now use
tinify.Format, with a note that the plain strings still work, and the
feature list mentions JPEG XL alongside the other convert targets.
@Sreini
Sreini merged commit cfa8b78 into master Nov 4, 2026
69 checks passed
@Sreini
Sreini deleted the docs/format-readme branch November 4, 2026 14:06
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