[sacOO7]

Summary

Aligns the README with the other Ably Pub/Sub 2.0 READMEs. The migration table moves after the
quick start, links point at this repository, and server samples read the API key from the
environment. Only README.md changes.

What changed

• Migrating from 1.x: now a top-level section after Quick start, with one sentence, a 1.x to 2.0 table and a link to UPDATING.md. The anchor is unchanged.
• Badges: the license badge reads ably/ably-pubsub-go instead of ably/ably-go.
• Known limitations and Support: issue links point at ably/ably-pubsub-go, because ably/ably-go is now a separate repository.
• API key: server samples read it from the ABLY_API_KEY environment variable.
• Links: repository files use absolute GitHub URLs.
• Quick start: the server-token note is now two sentences and links to the docs page on server clients and token authentication. New: a net/http endpoint at /ably-auth serves a token request, and the device sample uses it through WithAuthURL.
• Further reading: drops "SDK setup for Go", which now redirects to the generic getting-started page that "Getting started with Pub/Sub using Go" already covers.

How it was validated

• The migration table was checked against the 1.x (v1.4.1) and 2.0 module sources.
• The full samples pass go vet and go build in a scratch module against the main sources. The Endpoint, Proxy and Logging fragments build inside a wrapper.
• The new /ably-auth endpoint sample also passes go vet and go build. Run with a dummy key, it returns a token request with Content-Type: application/json.
• The UPDATING.md anchor exists. The badge and issue URLs resolve.
• Every link in the README resolves with a 200. Web docs links were compared with the last 1.x README; the only dropped one is the protocol v1 deprecation notice for 1.x versions.
• An independent review checked facts, the table, anchors 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 README asset, license, and reference links to point to the ably-pubsub-go repository and made contributing and issue-reporting links absolute.
  • Moved the 1.x migration guidance out of the Quick start section to a later overview.
  • Updated server, Endpoint, Proxy, and Logging examples to read API keys from the ABLY_API_KEY environment variable.
  • Shortened the server-authentication notice and linked to token-authentication guidance.

[coderabbitai]

Warning

Review limit reached

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

Next included review available in 36 minutes.

Check out review usage here.

View limit details

Limit details: You’ve used the included review currently available.

Learn how review limits work.

Review configuration:

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: be564bf1-848c-484b-bfcd-32457a1858a5

Commits

Reviewing files that changed from the base of the PR and between ad15e36 and 171df12.

Files selected for processing: 1

• README.md

Walkthrough

The README updates repository links, moves API keys in examples to the ABLY_API_KEY environment variable, and adds a 1.x-to-2.0 migration overview.

Changes

README updates

Layer / File(s)	Summary
Environment-based API key examples README.md	Server, Endpoint, Proxy, and Logging examples read keys from ABLY_API_KEY. The server-authentication notice links to external guidance.
Migration overview and repository links README.md	The README adds a 1.x-to-2.0 comparison and updates asset, license, and documentation links to the ably-pubsub-go repository.

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

Change: Other

Suggested reviewers: ttypic, rosalita

Merge Risk: Low · previous review ad15e

The README incorrectly says server clients require API keys, potentially misleading users configuring supported token authentication. This is a bounded documentation issue; the change is mergeable with that correction or an explicit follow-up.

Pre-merge checks: 4

Check name	Status	Explanation
Description Check		Check skipped - CodeRabbit’s high-level summary is enabled.
Title check		The title clearly summarizes the two main changes: moving the README migration table and reading the API key from the environment.
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 checks the README page,
And finds new links from age to age.
Keys now wait where env vars grow,
Migration paths are set to show.
The bunny hops, content to go.}

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: 33888b20-a584-4312-8aa3-f9e1ed88a369

Commits

Reviewing files that changed from the base of the PR and between 526e34d and ad15e36.

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

[ttypic]

LGTM