Skip to content

docs: refresh README - #144

Merged
ChiragAgg5k merged 3 commits into
mainfrom
dev
Oct 17, 2026
Merged

ChiragAgg5k merged 3 commits into
mainfrom
dev

Conversation

@ChiragAgg5k

Copy link
Copy Markdown
Member

Refreshes the README with the rewritten getting-started guide and corrected badges, links and install steps from appwrite/sdk-generator#2077 and appwrite/appwrite#14613.

README files only. No code, version or changelog changes, so this does not need a release.

@hansi-codes

hansi-codes Bot commented Oct 17, 2026 •

Copy link
Copy Markdown

🟢 Tier S · Ready to merge

The incremental documentation change accurately describes the push subscription handle and introduces no actionable issues.

Refreshes README installation guidance and the getting-started content, including client setup, requests, OAuth, Java usage, typed models, and push notifications. It also updates badges and documentation links, and clarifies the lifetime of push subscriptions.

Latest changes: The newest commit removes the immediate unsubscribe call from the push example and explains that callers should retain the subscription and unsubscribe when they stop listening, such as in onDestroy().

Verdict New comments Fixed Still open
✅ Approved 0 0 0
📂 Walkthrough · 1
File Change
README.md Updates badges, links, installation instructions, getting-started examples, and push-notification guidance; the latest change clarifies when to retain and unsubscribe a push subscription.

Reviewed the commits since 1bef1f3 · Details · Comment @hansi-codes review to re-run, or mention @hansi-codes with a question.

@hansi-codes hansi-codes Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 Tier S · Looks good to merge. Summary

@ChiragAgg5k
ChiragAgg5k merged commit f1f698b into main Oct 17, 2026
1 check 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