[sacOO7]

Summary

Simplifies the README to match the other Ably Pub/Sub 2.0 READMEs: a three-column overview,
one-line requirements and the migration table after the quick start. Only README.md changes.

What changed

• Overview: two sentences and a Package / Use it for / Entry point table, without a Platforms column.
• Requirements: one line, Java 8 or later, and Android 7.0 (API level 24) for the device package.
• Installation: one Gradle (Kotlin DSL) block per package. Maven only for device-jvm.
• Quick start: shorter server samples, a two-sentence server-client [!IMPORTANT] note that links to the token authentication docs, a token request served from a Spring Boot endpoint at /ably-auth, and the device sample that uses it as its authUrl.
• Migrating from 1.x: a top-level section after Quick start, with a 1.x to 2.0 table and a link to UPGRADING.md.
• Common configuration and Live Objects: shorter Endpoint, Proxy and Logging snippets. Live Objects is cut to the dependency, the channel modes and two links.
• Known limitations: one bullet on the API level 24 floor.
• API key: server samples read it from the ABLY_API_KEY environment variable.
• Further reading: drops the SDK setup for Java link, which now redirects to the generic getting-started page.
• Links: repository files use absolute GitHub URLs.

How it was validated

• Every claim was checked against the source on main: builder methods, Auth.createTokenRequest, Log levels, ChannelMode, and the Gradle minSdk and Java targets.
• The server samples and the Endpoint, Proxy and Logging snippets compile with javac --release 8. The device sample was checked statically.
• The /ably-auth endpoint sample compiles against the main sources and Spring Boot 3.3, and boots. With a dummy key, it returns a token request with Content-Type: application/json.
• Every link resolves (HTTP 200), including the UPGRADING.md anchor.
• 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.

Risk Assessment

Summary by CodeRabbit

• Documentation
  • Updated installation guidance with Gradle examples, Maven instructions for the device JVM artifact, and Java and Android requirements.
  • Refreshed quick starts with environment-based API keys, device token authentication, and authentication options.
  • Revised migration and configuration guidance, including endpoint ports, TLS authentication, proxies, logging, and network engines.
  • Updated LiveObjects, Android compatibility, contribution, and further-reading information.

[coderabbitai]

Walkthrough

The README updates package requirements and installation, server quick-start and authentication examples, migration guidance, and configuration details.

Changes

README documentation

Layer / File(s)	Summary
Package requirements and installation README.md	The README updates package and installation guidance, moves the migration summary, and states the Android API limitation.
Server examples and authentication README.md	The server examples use ABLY_API_KEY. The README adds a token-request endpoint example and describes authUrl and authCallback options.
Migration and configuration README.md	The README updates migration, endpoint and TLS rules, network engine options, proxy and logging examples, LiveObjects guidance, and reference links.

Estimated code review effort: 2 (Simple) | ~10 minutes

Change: Other

Possibly related issues

• ably/ably-pubsub-java#1255 — This PR updates README installation, Android API requirements, and examples covered by the issue. Other findings in the issue are not reflected in the supplied change summary.

Possibly related PRs

• ably/ably-pubsub-java#1256 — Both PRs update README guidance about 2.0 packages, endpoint and port rules, TLS, and token authentication.

Suggested reviewers: ttypic

Merge Risk: Moderate · up to 243aa

The revised quick start can hang, and copying the authentication endpoint without adding its missing session check permits anonymous token issuance. Correct these examples before merging; Android Maven and server-token guidance also need clarification.

Pre-merge checks: 4

Check name	Status	Explanation
Description Check		Check skipped - CodeRabbit’s high-level summary is enabled.
Title check		The title accurately describes the main change: simplifying and updating README.md. It is concise and clear.
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 README bright,
New package paths are clear in sight.
A token waits behind the door,
The quick-start shows the steps once more.
I twitch my nose and hop away,
With links to guide the reader’s way.}

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: 2205e094-e70d-4fe5-8ecc-d86292f4b52a

Commits

Reviewing files that changed from the base of the PR and between 9f5423a and 243aa13.

Files selected for processing: 1

• README.md

Included review availability: This review used your included allowance. Your plan provides up to 2 included reviews 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

[coderabbitai]

• Fix comments: Fix CodeRabbit comments on this PR

[ttypic]

LGTM