Skip to content

docs: refresh README - #342

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 README refreshes installation, platform setup, OAuth, typed request, and error-handling guidance, and adds current Push delivery instructions. The example README updates client and service examples for account creation, TablesDB, file uploads, realtime, and errors. The latest edits clarify that Push and realtime subscriptions stay active until explicitly closed.

Latest changes: The new commits remove immediate unsubscribe/close calls from the Push and realtime examples and explain when to end each subscription.

Verdict New comments Fixed Still open
✅ Approved 0 0 0
📂 Walkthrough · 2
File Change
README.md Refreshes installation and platform setup, OAuth and typed SDK examples, and Push setup and delivery guidance; the latest edit documents the subscription lifetime.
example/README.md Updates account, TablesDB, file upload, realtime, and error-handling examples; the latest edit explains when to close the realtime subscription.

Reviewed the commits since 2af5baa · 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 A · Looks good to merge. Summary

Comment thread example/README.md Outdated

@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 f529f78 into main Oct 17, 2026
2 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