Refactor README for improved clarity and structure#458
Merged
Conversation
Updated README.md to enhance formatting and add new sections.
Contributor
|
Caution Review failedThe pull request is closed. ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
WalkthroughReworks README layout: replaces initial badge cluster with new badges, adds a "Support Palestine" banner near the top, converts two sections into collapsible FAQs, replaces screenshot thumbnails with a 2×3 table, reorders several sections, and adds a "❤️ Support This Project" area; also normalizes markup/whitespace. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 4
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@README.md`:
- Around line 87-92: The two download badge <img> tags for the GitHub badge
(src="https://i.ibb.co/q0mdc4Z/get-it-on-github.png") and the F-Droid badge
(src="https://f-droid.org/badge/get-it-on.png") are missing alt attributes;
update those <img> elements in the README to include descriptive alt text (e.g.,
alt="Get it on GitHub" and alt="Get it on F-Droid") so they match the
Obtainium/GitHub Store badges and improve accessibility.
- Around line 67-76: The images lack alt text which makes them inaccessible;
update the banner <img src="media-resources/banner.jpeg" width="99%" /> and each
table cell image  through
 to include concise, descriptive
alt attributes (e.g., alt="Banner: [brief description]" and alt="Screenshot 1:
[brief description]" … "Screenshot 6: [brief description]") reflecting the
actual visual content so screen readers can convey their meaning.
- Around line 10-32: The badge images in README.md lack alt text which breaks
accessibility; update every <img> tag in the shown badge block (e.g., the Kotlin
badge, Apache-2.0 badge, Android/Windows/macOS/Linux badges,
downloads/stars/issues/release badges) to include meaningful alt attributes such
as "Kotlin badge", "Apache-2.0 license badge", "Android badge", "Windows badge",
"macOS badge", "Linux badge", "Downloads badge for OpenHub-Store/GitHub-Store",
"Stars badge for OpenHub-Store/GitHub-Store", "Issues badge for
OpenHub-Store/GitHub-Store", and "Release badge for OpenHub-Store/GitHub-Store"
so screen readers can convey their purpose.
- Around line 278-280: The Discord widget image tag is missing alt text; update
the <img> element inside the Discord link (the img with
src="https://invidget.switchblade.xyz/NBW4zeFcG6") to include a meaningful alt
attribute (e.g., alt="Discord server widget for NBW4zeFcG6" or alt="Join our
Discord server") so screen readers can describe the image for accessibility.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
Comment on lines
+67
to
+76
| <img src="media-resources/banner.jpeg" width="99%" /> | ||
| </p> | ||
|
|
||
| <div align="center"> | ||
| | 1 | 2 | 3 | | ||
| | --- | --- | --- | | ||
| |  |  |  | | ||
|
|
||
| # 📔 Wiki & Resources | ||
|
|
||
| Check out GitHub Store [Wiki](https://github.com/OpenHub-Store/GitHub-Store/wiki) for FAQ and useful information | ||
|
|
||
| 🌐 **Website:** [github-store.org](https://github-store.org) | ||
| 💬 **Discord:** [Join the community](https://discord.gg/x9Cvh2Z9qS) | ||
| 📜 **Privacy Policy:** [github-store.org/privacy-policy](https://github-store.org/privacy-policy/) | ||
|
|
||
| </div> | ||
| | 4 | 5 | 6 | | ||
| | --- | --- | --- | | ||
| |  |  |  | |
Contributor
There was a problem hiding this comment.
Add descriptive alt text to banner and screenshot images.
The banner image and all six screenshot images in the table lack alt text, making the visual content inaccessible to screen reader users.
♿ Proposed fix for banner and screenshots
<p align="center">
- <img src="media-resources/banner.jpeg" width="99%" />
+ <img alt="GitHub Store app banner" src="media-resources/banner.jpeg" width="99%" />
</p>
| 1 | 2 | 3 |
| --- | --- | --- |
-|  |  |  |
+|  |  |  |
| 4 | 5 | 6 |
| --- | --- | --- |
-|  |  |  |
+|  |  |  |Note: Adjust the alt text descriptions based on what each screenshot actually shows.
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| <img src="media-resources/banner.jpeg" width="99%" /> | |
| </p> | |
| <div align="center"> | |
| | 1 | 2 | 3 | | |
| | --- | --- | --- | | |
| |  |  |  | | |
| # 📔 Wiki & Resources | |
| Check out GitHub Store [Wiki](https://github.com/OpenHub-Store/GitHub-Store/wiki) for FAQ and useful information | |
| 🌐 **Website:** [github-store.org](https://github-store.org) | |
| 💬 **Discord:** [Join the community](https://discord.gg/x9Cvh2Z9qS) | |
| 📜 **Privacy Policy:** [github-store.org/privacy-policy](https://github-store.org/privacy-policy/) | |
| </div> | |
| | 4 | 5 | 6 | | |
| | --- | --- | --- | | |
| |  |  |  | | |
| <img alt="GitHub Store app banner" src="media-resources/banner.jpeg" width="99%" /> | |
| </p> | |
| | 1 | 2 | 3 | | |
| | --- | --- | --- | | |
| |  |  |  | | |
| | 4 | 5 | 6 | | |
| | --- | --- | --- | | |
| |  |  |  | |
🧰 Tools
🪛 markdownlint-cli2 (0.22.1)
[warning] 67-67: Images should have alternate text (alt text)
(MD045, no-alt-text)
[warning] 72-72: Images should have alternate text (alt text)
(MD045, no-alt-text)
[warning] 72-72: Images should have alternate text (alt text)
(MD045, no-alt-text)
[warning] 72-72: Images should have alternate text (alt text)
(MD045, no-alt-text)
[warning] 76-76: Images should have alternate text (alt text)
(MD045, no-alt-text)
[warning] 76-76: Images should have alternate text (alt text)
(MD045, no-alt-text)
[warning] 76-76: Images should have alternate text (alt text)
(MD045, no-alt-text)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@README.md` around lines 67 - 76, The images lack alt text which makes them
inaccessible; update the banner <img src="media-resources/banner.jpeg"
width="99%" /> and each table cell image
 through
 to include concise, descriptive
alt attributes (e.g., alt="Banner: [brief description]" and alt="Screenshot 1:
[brief description]" … "Screenshot 6: [brief description]") reflecting the
actual visual content so screen readers can convey their meaning.
Comment on lines
+278
to
+280
| <a href="https://discord.gg/NBW4zeFcG6"> | ||
| <img src="https://invidget.switchblade.xyz/NBW4zeFcG6" /> | ||
| </a> |
Contributor
There was a problem hiding this comment.
Add alt text to Discord server widget image.
The Discord server widget image lacks alt text, making it inaccessible to screen reader users.
♿ Proposed fix
<a href="https://discord.gg/NBW4zeFcG6">
- <img src="https://invidget.switchblade.xyz/NBW4zeFcG6" />
+ <img alt="Join GitHub Store Discord Server" src="https://invidget.switchblade.xyz/NBW4zeFcG6" />
</a>🧰 Tools
🪛 markdownlint-cli2 (0.22.1)
[warning] 279-279: Images should have alternate text (alt text)
(MD045, no-alt-text)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@README.md` around lines 278 - 280, The Discord widget image tag is missing
alt text; update the <img> element inside the Discord link (the img with
src="https://invidget.switchblade.xyz/NBW4zeFcG6") to include a meaningful alt
attribute (e.g., alt="Discord server widget for NBW4zeFcG6" or alt="Join our
Discord server") so screen readers can describe the image for accessibility.
Contributor
Author
|
@coderabbitai help |
Contributor
ChatThere are 3 ways to chat with CodeRabbit:
CodeRabbit commands
Other keywords and placeholders
Status, support, documentation and community
|
Updated badge links in README.md to include alt text.
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (4)
README.md (4)
279-279:⚠️ Potential issue | 🟠 MajorDiscord widget image is missing alt text (Line 279).
The image in the Discord section should include a readable
altlabel.Proposed fix
- <img src="https://invidget.switchblade.xyz/NBW4zeFcG6" /> + <img src="https://invidget.switchblade.xyz/NBW4zeFcG6" alt="Join the GitHub Store Discord server" />🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@README.md` at line 279, The Discord widget image tag lacks an accessible alt attribute; update the <img> element (the Discord widget line containing src="https://invidget.switchblade.xyz/NBW4zeFcG6") to include a meaningful alt text (e.g., alt="Discord widget for [server name]" or alt="Discord member count and online status") so screen readers can describe the image.
88-88:⚠️ Potential issue | 🟠 MajorDownload badge images are still missing alt text (Lines 88, 91).
Both linked images should include meaningful
altattributes for accessibility consistency.Proposed fix
- <img src="https://i.ibb.co/q0mdc4Z/get-it-on-github.png" height="80" /> + <img src="https://i.ibb.co/q0mdc4Z/get-it-on-github.png" height="80" alt="Get it on GitHub" /> ... - <img src="https://f-droid.org/badge/get-it-on.png" height="80" /> + <img src="https://f-droid.org/badge/get-it-on.png" height="80" alt="Get it on F-Droid" />Also applies to: 91-91
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@README.md` at line 88, The two badge <img> elements (e.g., the one with src "https://i.ibb.co/q0mdc4Z/get-it-on-github.png" and the other badge at the same section) are missing alt text; update each <img> tag to include a meaningful alt attribute (for example "Get it on GitHub" or similar descriptive text) so both images provide accessible descriptions.
14-17:⚠️ Potential issue | 🟠 MajorPlatform badge images still miss alt text (Lines 14–17).
These badges are not accessible without
altattributes.Proposed fix
- <img src="https://ziadoua.github.io/m3-Markdown-Badges/badges/Android/android1.svg" /> - <img src="https://ziadoua.github.io/m3-Markdown-Badges/badges/Windows/windows1.svg" /> - <img src="https://ziadoua.github.io/m3-Markdown-Badges/badges/macOS/macos1.svg" /> - <img src="https://ziadoua.github.io/m3-Markdown-Badges/badges/Linux/linux2.svg" /> + <img src="https://ziadoua.github.io/m3-Markdown-Badges/badges/Android/android1.svg" alt="Android badge" /> + <img src="https://ziadoua.github.io/m3-Markdown-Badges/badges/Windows/windows1.svg" alt="Windows badge" /> + <img src="https://ziadoua.github.io/m3-Markdown-Badges/badges/macOS/macos1.svg" alt="macOS badge" /> + <img src="https://ziadoua.github.io/m3-Markdown-Badges/badges/Linux/linux2.svg" alt="Linux badge" />🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@README.md` around lines 14 - 17, The four <img> badge elements for Android, Windows, macOS, and Linux are missing alt attributes; update each <img> tag (the ones using ziadoua.github.io/m3-Markdown-Badges URLs) to include concise, descriptive alt text (e.g., alt="Android badge", alt="Windows badge", alt="macOS badge", alt="Linux badge") so the badges are accessible to screen readers and meet accessibility standards.
67-67:⚠️ Potential issue | 🟠 MajorBanner and screenshot images still lack descriptive alt text (Lines 67, 72, 76).
<img>and markdown images with emptyremain inaccessible.Proposed fix
- <img src="media-resources/banner.jpeg" width="99%" /> + <img src="media-resources/banner.jpeg" width="99%" alt="GitHub Store promotional banner" /> ... -|  |  |  | +|  |  |  | ... -|  |  |  | +|  |  |  |Also applies to: 72-72, 76-76
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@README.md` at line 67, Update the empty alt text for the images referenced in README.md: replace the HTML <img src="media-resources/banner.jpeg" width="99%" /> with an accessible <img> that includes a descriptive alt attribute (e.g., alt="Project banner showing ..."), and replace any markdown image occurrences using  with descriptive alt text like , ensuring each image (banner and the two screenshots) has a meaningful alt string describing the content and purpose.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@README.md`:
- Line 3: The header image tag in README.md is missing an alt attribute which
prevents screen readers from announcing it; update the <img
src="media-resources/app_icon.png" width="200" /> element to include a
meaningful alt text (e.g., alt="App icon" or a more descriptive phrase like
alt="MyApp logo") so assistive technologies can convey its purpose.
---
Duplicate comments:
In `@README.md`:
- Line 279: The Discord widget image tag lacks an accessible alt attribute;
update the <img> element (the Discord widget line containing
src="https://invidget.switchblade.xyz/NBW4zeFcG6") to include a meaningful alt
text (e.g., alt="Discord widget for [server name]" or alt="Discord member count
and online status") so screen readers can describe the image.
- Line 88: The two badge <img> elements (e.g., the one with src
"https://i.ibb.co/q0mdc4Z/get-it-on-github.png" and the other badge at the same
section) are missing alt text; update each <img> tag to include a meaningful alt
attribute (for example "Get it on GitHub" or similar descriptive text) so both
images provide accessible descriptions.
- Around line 14-17: The four <img> badge elements for Android, Windows, macOS,
and Linux are missing alt attributes; update each <img> tag (the ones using
ziadoua.github.io/m3-Markdown-Badges URLs) to include concise, descriptive alt
text (e.g., alt="Android badge", alt="Windows badge", alt="macOS badge",
alt="Linux badge") so the badges are accessible to screen readers and meet
accessibility standards.
- Line 67: Update the empty alt text for the images referenced in README.md:
replace the HTML <img src="media-resources/banner.jpeg" width="99%" /> with an
accessible <img> that includes a descriptive alt attribute (e.g., alt="Project
banner showing ..."), and replace any markdown image occurrences using 
with descriptive alt text like ,
ensuring each image (banner and the two screenshots) has a meaningful alt string
describing the content and purpose.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (4)
README.md (4)
279-279:⚠️ Potential issue | 🟠 MajorDiscord widget image is missing alt text.
Line 279 still has an
<img>withoutalt, which is inaccessible for screen readers and duplicates an earlier finding.Proposed fix
- <img src="https://invidget.switchblade.xyz/NBW4zeFcG6" /> + <img src="https://invidget.switchblade.xyz/NBW4zeFcG6" alt="Join the GitHub Store Discord server" />🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@README.md` at line 279, The Discord widget <img> tag with src "https://invidget.switchblade.xyz/NBW4zeFcG6" is missing an alt attribute; update that <img> element to include a meaningful alt text (e.g., alt="Discord server widget showing member/activity stats") to improve accessibility and avoid duplication of the earlier missing-alt finding.
88-88:⚠️ Potential issue | 🟠 MajorAdd alt text to GitHub and F-Droid download badges.
The images on Line 88 and Line 91 are missing
altvalues. This is the same accessibility issue previously identified for this section.Proposed fix
- <img src="https://i.ibb.co/q0mdc4Z/get-it-on-github.png" height="80" /> + <img src="https://i.ibb.co/q0mdc4Z/get-it-on-github.png" height="80" alt="Get it on GitHub" /> ... - <img src="https://f-droid.org/badge/get-it-on.png" height="80" /> + <img src="https://f-droid.org/badge/get-it-on.png" height="80" alt="Get it on F-Droid" />Also applies to: 91-91
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@README.md` at line 88, The GitHub and F-Droid badge images are missing alt text; update the two <img> elements (e.g., the one with src "https://i.ibb.co/q0mdc4Z/get-it-on-github.png" and the other F-Droid badge image on Line 91) to include meaningful alt attributes like alt="Get it on GitHub" and alt="Get it on F‑Droid" respectively so the badges are accessible to screen readers.
14-17:⚠️ Potential issue | 🟠 MajorAdd alt text for platform badge images.
Lines 14–17 still use
<img>tags withoutalt, so screen readers won’t announce these badges. This was already flagged earlier and appears reintroduced.Proposed fix
- <img src="https://ziadoua.github.io/m3-Markdown-Badges/badges/Android/android1.svg" /> - <img src="https://ziadoua.github.io/m3-Markdown-Badges/badges/Windows/windows1.svg" /> - <img src="https://ziadoua.github.io/m3-Markdown-Badges/badges/macOS/macos1.svg" /> - <img src="https://ziadoua.github.io/m3-Markdown-Badges/badges/Linux/linux2.svg" /> + <img src="https://ziadoua.github.io/m3-Markdown-Badges/badges/Android/android1.svg" alt="Android badge" /> + <img src="https://ziadoua.github.io/m3-Markdown-Badges/badges/Windows/windows1.svg" alt="Windows badge" /> + <img src="https://ziadoua.github.io/m3-Markdown-Badges/badges/macOS/macos1.svg" alt="macOS badge" /> + <img src="https://ziadoua.github.io/m3-Markdown-Badges/badges/Linux/linux2.svg" alt="Linux badge" />🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@README.md` around lines 14 - 17, The README's platform badge <img> elements lack alt attributes, which hurts accessibility; update each badge <img> tag (the Android, Windows, macOS, Linux badge images shown) to include a meaningful alt text like "Android badge", "Windows badge", "macOS badge", and "Linux badge" respectively so screen readers can announce them.
67-67:⚠️ Potential issue | 🟠 MajorBanner and screenshot images need descriptive alt text.
Line 67 and the screenshot cells on Lines 72 and 76 still use empty alt text syntax, which is an accessibility gap and matches a previously reported issue.
Proposed fix
- <img src="media-resources/banner.jpeg" width="99%" /> + <img src="media-resources/banner.jpeg" width="99%" alt="GitHub Store banner" /> -|  |  |  | +|  |  |  | -|  |  |  | +|  |  |  |Also applies to: 72-72, 76-76
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@README.md` at line 67, The README contains <img> tags (e.g., the banner image tag shown and the screenshot image cells) with empty alt attributes; update those image elements to include concise, descriptive alt text that describes the image content and purpose (for example replace alt="" with alt="Project banner showing X" or alt="Screenshot of Y feature") for the banner and the screenshots referenced in the README to satisfy accessibility requirements.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@README.md`:
- Line 360: The "⭐ **[Star](.../star)**" markdown link in README.md points to a
nonstandard "/star" route causing a broken CTA; update that link target to a
valid repository page such as "/stargazers" (or the repo root) by replacing the
href in the "⭐ **[Star](.../star)**" link so the call-to-action reliably
navigates to the stargazers page.
---
Duplicate comments:
In `@README.md`:
- Line 279: The Discord widget <img> tag with src
"https://invidget.switchblade.xyz/NBW4zeFcG6" is missing an alt attribute;
update that <img> element to include a meaningful alt text (e.g., alt="Discord
server widget showing member/activity stats") to improve accessibility and avoid
duplication of the earlier missing-alt finding.
- Line 88: The GitHub and F-Droid badge images are missing alt text; update the
two <img> elements (e.g., the one with src
"https://i.ibb.co/q0mdc4Z/get-it-on-github.png" and the other F-Droid badge
image on Line 91) to include meaningful alt attributes like alt="Get it on
GitHub" and alt="Get it on F‑Droid" respectively so the badges are accessible to
screen readers.
- Around line 14-17: The README's platform badge <img> elements lack alt
attributes, which hurts accessibility; update each badge <img> tag (the Android,
Windows, macOS, Linux badge images shown) to include a meaningful alt text like
"Android badge", "Windows badge", "macOS badge", and "Linux badge" respectively
so screen readers can announce them.
- Line 67: The README contains <img> tags (e.g., the banner image tag shown and
the screenshot image cells) with empty alt attributes; update those image
elements to include concise, descriptive alt text that describes the image
content and purpose (for example replace alt="" with alt="Project banner showing
X" or alt="Screenshot of Y feature") for the banner and the screenshots
referenced in the README to satisfy accessibility requirements.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
|
|
||
| GitHub Store is 100% free. No ads. No tracking. | ||
|
|
||
| - ⭐ **[Star](https://github.com/OpenHub-Store/GitHub-Store/star)** this repository |
Contributor
There was a problem hiding this comment.
Fix the Star link path to avoid a broken CTA.
Line 360 links to /star, which is not a standard repository page route. Use /stargazers (or repo root) so the call-to-action reliably works.
Proposed fix
-- ⭐ **[Star](https://github.com/OpenHub-Store/GitHub-Store/star)** this repository
+- ⭐ **[Star](https://github.com/OpenHub-Store/GitHub-Store/stargazers)** this repository📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| - ⭐ **[Star](https://github.com/OpenHub-Store/GitHub-Store/star)** this repository | |
| - ⭐ **[Star](https://github.com/OpenHub-Store/GitHub-Store/stargazers)** this repository |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@README.md` at line 360, The "⭐ **[Star](.../star)**" markdown link in
README.md points to a nonstandard "/star" route causing a broken CTA; update
that link target to a valid repository page such as "/stargazers" (or the repo
root) by replacing the href in the "⭐ **[Star](.../star)**" link so the
call-to-action reliably navigates to the stargazers page.
Updated badge links and added new sections for features, FAQ, and project support.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Updated README.md to enhance formatting and add new sections.
Summary by CodeRabbit