[sacOO7]

Summary

Rewrites the README for the 2.0 ably/pubsub-server package to match the other Ably Pub/Sub 2.0
READMEs. PHP has one server package with an HTTP client only, so there is one set of installation,
quick start and configuration sections. Only README.md changes.

What changed

• Overview: a one-sentence intro, the server-only note and a Package / Use it for / Entry point table. Packagist and license badges.
• Requirements: one line, PHP 8.1 or later with the curl, json and openssl extensions.
• Installation: composer require ably/pubsub-server only.
• Quick start: a publish and history sample, a two-sentence server-token note that links to the docs page on server clients and token authentication, and a token request served from a plain ably-auth.php script at /ably-auth, which device SDKs use as their authUrl. Laravel apps are pointed to the Laravel broadcaster.
• Migrating from 1.x: a top-level section after Quick start, with a 1.x to 2.0 table and a link to UPDATING.md.
• Common configuration: Endpoint, Proxy and Logging, each with its rules and a short sample.
• Platform notes and Known limitations: the Laravel packages still depend on 1.x, and there is no realtime client.
• API key: server samples read it from the ABLY_API_KEY environment variable.
• Links: repository files use absolute GitHub URLs.

How it was validated

• Every class, method, option and constant was traced to src/ on main. The requirements match composer.json and the CI matrix.
• The PHP samples parse with php-parser. php -l could not run locally.
• The ably-auth.php sample parses with php-parser, and its calls were traced to src/ on main. The Laravel sentence was checked against the laravel-broadcaster source and Ably's Laravel Echo fork.
• Links and the UPDATING.md anchors were checked.
• An independent review checked facts, samples, links and markdown rendering.

Follow-ups

• The #server-token-auth anchor on the token authentication docs page is not published yet; the link opens the top of the page until it is.
• UPDATING.md and the 2.0.0 CHANGELOG entry refer to a maintenance/1.x branch that does not exist.
• The Laravel packages need releases that depend on ably/pubsub-server.

Risk Assessment

Summary by CodeRabbit

• Documentation
  • Reworked the README to describe the PHP SDK’s server-side requirements, installation, and usage.
  • Added examples for publishing messages, reading history, and making token requests.
  • Documented API-key authentication and configuration for endpoints, proxies, logging, and migrations.
  • Clarified PHP platform support, Laravel compatibility, and REST-only limitations.

[coderabbitai]

Walkthrough

The README now focuses on server-side use of the PHP SDK. It adds installation requirements, examples, configuration guidance, migration mappings, platform notes, and updated support links.

Changes

Server SDK documentation

Layer / File(s)	Summary
Server SDK usage and reference guidance README.md	Adds PHP and extension requirements, publishing and history examples, token-request guidance, authentication requirements, configuration options, migration mappings, Laravel compatibility notes, REST-only limitations, and support links.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Change: Other

Possibly related PRs

• ably/ably-pubsub-php#227 — The README documents the package, namespace, client factory, endpoint option, and migration guide added by that PR.
• ably/ably-pubsub-php#233 — The PR updates the PHP requirement and supported-platform documentation; this README documents the same support contract.

Suggested reviewers: umair-ably

Merge Risk: Low · up to 22dbf

Users may receive misleading setup guidance or encounter broken migration and authentication links; the issues are straightforward documentation fixes and the package remains otherwise mergeable.

Pre-merge checks: 4

Check name	Status	Explanation
Description Check		Check skipped - CodeRabbit’s high-level summary is enabled.
Title check		The title clearly and concisely describes the main change: rewriting the README for the 2.0 SDK.
Linked Issues check		Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check		Check skipped because no linked issues were found for this pull request.

Finishing Touches

Generate unit tests (beta)

• Commit to this branch
• Create a new PR

• Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

Share

• X
• Mastodon
• Reddit
• LinkedIn

_{A rabbit reads the server guide,
With PHP notes tucked inside.
It hops through history, token, key,
And finds migration paths to see.
“The README’s fresh!” it says with cheer,
Then nibbles carrots, page held near.}

CodeRabbit Verify

• Run CodeRabbit Verify to test the changes in this pull request.

Recent review info

Run configuration

• Source mode: Auto
• Repository: Unavailable
• Branch: Unavailable
• File: No configuration file from this repository applied
• Commit: Unavailable
• Layers: Organization UI
• Review profile: CHILL
• Plan: Advanced
• Run ID: f93e69e7-1fcb-411e-ae48-92d6cdd95f1b

Commits

Reviewing files that changed from the base of the PR and between 552da3b and 22dbf95.

Files selected for processing: 1

• README.md

Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.

[coderabbitai]

• Fix comments: Fix CodeRabbit comments on this PR

[coderabbitai]

• Fix comments: Fix CodeRabbit comments on this PR

[ttypic]

LGTM