Added Button for downloading Resonate from Google Play Store#518
Added Button for downloading Resonate from Google Play Store#518TheGoodUser wants to merge 1 commit intoAOSSIE-Org:masterfrom TheGoodUser:readme-updates
Conversation
WalkthroughThe README was updated with a promotional banner, expanded features list, reworked screenshots gallery, added Getting Started and Contributing sections, updated maintainer/contact info, and general formatting/whitespace cleanup. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
✨ Finishing Touches🧪 Generate unit tests
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (9)
README.md (9)
3-5: Correct alt text for the AOSSIE logo.Alt should describe the actual image.
-<img src="assets/images/aossie_logo.png" alt="Resonate logo" width="150" height="auto" /> +<img src="assets/images/aossie_logo.png" alt="AOSSIE logo" width="150" height="auto" />
14-17: Use raw asset URLs to avoid “blob” pages failing to render as images.Switch to raw.githubusercontent.com for reliability.
-<source media="(prefers-color-scheme: dark)" align="center" srcset="https://github.com/appwrite/website/blob/main/static/images/logos/appwrite.svg" +<source media="(prefers-color-scheme: dark)" align="center" srcset="https://raw.githubusercontent.com/appwrite/website/main/static/images/logos/appwrite.svg" alt="Appwrite Logo" width="200"> -<img alt="Appwrite Logo" align="center" src="https://github.com/appwrite/website/blob/main/static/images/logos/appwrite-light.svg" alt="Appwrite Logo" +<img alt="Appwrite Logo" align="center" src="https://raw.githubusercontent.com/appwrite/website/main/static/images/logos/appwrite-light.svg" alt="Appwrite Logo" width="200">
74-76: Fix grammar/typos in Features.Improves clarity and professionalism.
-4. Listen to and Stories as chapters with synced lyrics, browse through entire catalog of stories following your favourate creators and waiting for their latest chapter/story releases. Post your own stories having chapters. (work in progess) +4. Listen to Stories as chapters with synced lyrics; browse the catalog of stories, follow your favorite creators, and track their latest chapter/story releases. Post your own stories with chapters. (work in progress) -6. Friend People/Profiles enabling your self to talk on voice calls/realtime messaging with them (coming soon) +6. Friends/Profiles enabling voice calls and real-time messaging (coming soon)
83-83: Prefer the concise term “WebRTC.”Minor terminology polish.
-3. **LiveKit** - Web Real-Time Communication +3. **LiveKit** - WebRTC
91-95: Polish Getting Started copy and fix capitalization/link.Also standardize “LiveKit.”
-Resonate is a wide project taking use of other software solutions like Appwrite and Livekit, starting up can be a little challenging +Resonate is a broad project that uses other software solutions like Appwrite and LiveKit, so getting started can be a little challenging. - -We offer a guide for walking you through setting up the entire project, including a script that automates the set up of the backend environment for you. -Please go through and strictly follow the [Onboarding Guide](https://github.com/Aarush-Acharya/Resonate/blob/master/ONBOARDING.md) for setting up the project for development and further contribution +We offer a guide to walk you through setting up the entire project, including a script that automates the backend environment setup. +Please follow the [Onboarding Guide](https://github.com/AOSSIE-Org/Resonate/blob/master/ONBOARDING.md) to set up the project for development and contributions.Note: verify the correct ONBOARDING.md location before merging.
100-102: Add alt text to screenshot images (accessibility, MD045).-| <img src= "https://github.com/user-attachments/assets/e76147b1-0e51-4852-8198-06bbc975b25c" width="260" height="auto" /> | <img src="https://github.com/user-attachments/assets/ad62eecb-b621-4c31-a01c-001ff5462b28" width="250" height="auto" /> | <img src="https://github.com/user-attachments/assets/31ce6e73-8dca-4e2d-8f48-c22480fa1332" width="250" height="auto" /> | +| <img alt="Login Screen (Forest)" src="https://github.com/user-attachments/assets/e76147b1-0e51-4852-8198-06bbc975b25c" width="260" height="auto" /> | <img alt="Home Screen (Time)" src="https://github.com/user-attachments/assets/ad62eecb-b621-4c31-a01c-001ff5462b28" width="250" height="auto" /> | <img alt="Create Room Screen (Time)" src="https://github.com/user-attachments/assets/31ce6e73-8dca-4e2d-8f48-c22480fa1332" width="250" height="auto" /> |
104-106: Add alt text to screenshot images (accessibility, MD045).-| <img src="https://github.com/user-attachments/assets/f1d6e62f-5f25-47c1-9f59-e165d7018c0c" width="250" height="auto" /> | <img src="https://github.com/user-attachments/assets/b9dfe363-79b1-4eee-8d00-28f5c14f93ee" width="250" height="auto" /> | <img src="https://github.com/user-attachments/assets/c7657be8-bce2-4c3a-aee3-dd3cc33379a2" width="250" height="auto"/> | +| <img alt="Room Screen (Cream)" src="https://github.com/user-attachments/assets/f1d6e62f-5f25-47c1-9f59-e165d7018c0c" width="250" height="auto" /> | <img alt="Profile Screen (Amber)" src="https://github.com/user-attachments/assets/b9dfe363-79b1-4eee-8d00-28f5c14f93ee" width="250" height="auto" /> | <img alt="Explore Story (Forest)" src="https://github.com/user-attachments/assets/c7657be8-bce2-4c3a-aee3-dd3cc33379a2" width="250" height="auto"/> |
108-110: Add alt text to screenshot images (accessibility, MD045).-| <img src="https://github.com/user-attachments/assets/ba7da784-48a6-4512-a4c8-9f12b8ad13c1" width="250" height="auto" /> | <img src="https://github.com/user-attachments/assets/ba9273f2-ceef-441d-8f94-4e0bc53b3e99" width="250" height="auto" /> | <img src="https://github.com/user-attachments/assets/a46c7da4-2df4-4c62-9e4c-9c92102339e9" width="250" height="auto"/> | +| <img alt="Explore Story (Amber)" src="https://github.com/user-attachments/assets/ba7da784-48a6-4512-a4c8-9f12b8ad13c1" width="250" height="auto" /> | <img alt="Theme Screen (Vintage)" src="https://github.com/user-attachments/assets/ba9273f2-ceef-441d-8f94-4e0bc53b3e99" width="250" height="auto" /> | <img alt="Upcoming Room Screen (Cream)" src="https://github.com/user-attachments/assets/a46c7da4-2df4-4c62-9e4c-9c92102339e9" width="250" height="auto"/> |
12-27: Logos sourced from third-party repos may change; consider vendoring or pinning.To avoid future breakage, copy assets into this repo or pin to a specific tag/commit.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (1)
README.md(4 hunks)
🧰 Additional context used
🪛 LanguageTool
README.md
[grammar] ~86-~86: There might be a mistake here.
Context: ...pository Links 1. Resonate Flutter App 2. [Resonate Backend](https://github.com/AOS...
(QB_NEW_EN)
[grammar] ~93-~93: There might be a mistake here.
Context: ...t up of the backend environment for you. Please go through and strictly follow th...
(QB_NEW_EN)
[grammar] ~100-~100: There might be a mistake here.
Context: ...een (Time) | Create Room Screen (Time) | | :--- | :--- | ...
(QB_NEW_EN)
[grammar] ~101-~101: There might be a mistake here.
Context: ... | :--- | :--- | | <img src= "https://github.com/user-att...
(QB_NEW_EN)
[grammar] ~126-~126: There might be a mistake here.
Context: ...! ## ✌️ Maintainers - Jaideep Prasad - [Chandan S Gowda](https://github.com/chan...
(QB_NEW_EN)
[grammar] ~133-~133: There might be a mistake here.
Context: ...e following channels: - Discord Server - Email <!-...
(QB_NEW_EN)
🪛 markdownlint-cli2 (0.17.2)
README.md
102-102: Images should have alternate text (alt text)
(MD045, no-alt-text)
102-102: Images should have alternate text (alt text)
(MD045, no-alt-text)
102-102: Images should have alternate text (alt text)
(MD045, no-alt-text)
106-106: Images should have alternate text (alt text)
(MD045, no-alt-text)
106-106: Images should have alternate text (alt text)
(MD045, no-alt-text)
106-106: Images should have alternate text (alt text)
(MD045, no-alt-text)
110-110: Images should have alternate text (alt text)
(MD045, no-alt-text)
110-110: Images should have alternate text (alt text)
(MD045, no-alt-text)
110-110: Images should have alternate text (alt text)
(MD045, no-alt-text)
🔇 Additional comments (2)
README.md (2)
118-118: Contributing note vs PR target mismatch (dev vs master).Text asks contributors to use dev, but this PR targets master. Align policy or retarget.
51-51: Verify Play Store listing/ID.Confirm that com.resonate.resonate is published and correct for this app before merging the CTA.
|
Hey @TheGoodUser , Thank you for the contribution. A couple of points to note:
|
M4dhav
added
documentation
M4dhav
left a comment
M4dhav
left a comment
There was a problem hiding this comment.
Please look into the suggested changes
|
Thanks for the feedback! Changes made:
Ready for review! |
|
Closing as duplicate of #520 |
2 participants
Description
Added an attractive download section to the README with Google Play Store button to improve user experience and app discoverability. The section includes professional styling with animations and clear call-to-action text.
Fixes: #517
Type of change
Preview
How Has This Been Tested?
Checklist:
Summary by CodeRabbit