Skip to content

Remove version-specific references from README#36

Merged
Subterrane merged 1 commit into
masterfrom
docs/version-agnostic-readme
Jun 9, 2026
Merged

Remove version-specific references from README#36
Subterrane merged 1 commit into
masterfrom
docs/version-agnostic-readme

Conversation

@Subterrane

Copy link
Copy Markdown
Contributor

Problem

The README embedded a per-version changelog block (### Version 1.8.0 - Exception Handling Support & Bug Fixes) and a hardcoded PHP >5.6 dependency line. Both required hand-editing on every release and had already drifted out of date (the SDK requires PHP >=8.1 per composer.json).

Fix

  • Replaced the inline version-specific changelog section under Getting started with a stable pointer to the Releases page, which is already the source of truth for release notes.
  • Replaced the stale PHP >5.6 / guzzle dependency list with a pointer to composer.json (the authoritative requirement list), so it never goes stale again.
  • Kept the exception-handling documentation itself (it moved to a version-agnostic intro sentence linking to the existing Errors and exceptions section).

After this, cutting a release is a pure tag-and-publish with no README edits required.

@Subterrane Subterrane merged commit 7ea7535 into master Jun 9, 2026
3 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