Skip to content

Trim the README to Laravel style, pointing at glimpseimg.com/docs/sdk - #6

Merged
mathiasgrimm merged 3 commits into
mainfrom
docs-first-readme
Jul 19, 2026
Merged

Trim the README to Laravel style, pointing at glimpseimg.com/docs/sdk#6
mathiasgrimm merged 3 commits into
mainfrom
docs-first-readme

Conversation

@mathiasgrimm

Copy link
Copy Markdown
Owner

Implements the glimpse-php half of Art-Commerce-Systems/glimpseimg.com#73. The full documentation moved to glimpseimg.com/docs/sdk (Art-Commerce-Systems/glimpseimg.com#74), so the README becomes a pitch with install, one example, and links into the docs.

What changed

  • README trimmed from ~300 lines to the banner, tagline, badges, pitch paragraph, install plus the convert example, a Documentation section linking every docs page, Development/Releasing, and License.
  • The v2 upgrade guide moved to https://glimpseimg.com/docs/sdk/upgrade; the README keeps a one-line pointer, so there is a single editable copy.
  • The docs methods page also fixes two spots where this README had gone stale: it documents the full public type surface (ImageResolution, ProbeResult, UsagePeriod, the ImageFormat helpers) and the real framework support (illuminate/http 10 to 13; the README said Laravel 10 to 12).
  • The surviving tagline drops "inspect" per the canonical verb list, and the footer calls glimpse-cli "the first-party CLI" (Art-Commerce-Systems/glimpseimg.com#64).

Nothing was deleted that is not already covered by the docs PR; merge that one first.

composer test passes (Pint, PHPStan, Pest).

🤖 Generated with Claude Code

mathiasgrimm and others added 3 commits July 19, 2026 00:39
The full SDK documentation now lives at glimpseimg.com/docs/sdk, so
the README keeps only the banner, the pitch, the install-plus-example
block, and links into the docs, Laravel style. The v2 upgrade guide's
canonical copy is the docs upgrade page; the README keeps a one-line
pointer. The surviving tagline and footer adopt the canonical wording
from Art-Commerce-Systems/glimpseimg.com#64.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Review finding: analyze() returns a plain list of SizeEstimate
objects, so the singular claim was wrong.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
The description said inspect; issue
Art-Commerce-Systems/glimpseimg.com#64 defines the canonical list as
convert, optimize, resize, thumbnail and analyze, which the trimmed
README tagline already uses.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@mathiasgrimm
mathiasgrimm merged commit a9a7702 into main Jul 19, 2026
5 checks passed
@mathiasgrimm
mathiasgrimm deleted the docs-first-readme branch July 19, 2026 16:11
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