Skip to content

Commit ebf3a0c

Browse files
rainxchzedrainxchzed
authored
Revise README for clarity and add visuals
Updated README.md to enhance project overview and visuals.
1 parent b12d91f commit ebf3a0c

1 file changed

Lines changed: 96 additions & 50 deletions

File tree

‎README.md‎

Lines changed: 96 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -1,89 +1,135 @@
11
<div align="center">
2-
<img src="https://github.com/rainxchzed/Github-Store/blob/main/composeApp/src/commonMain/composeResources/drawable/app-icon.png" width="200" alt="Project logo"/>
2+
</br>
3+
<img src="./composeApp/src/commonMain/composeResources/drawable/app-icon.png" width="200" />
4+
35
</div>
46

5-
<h1 align="center">GitHub Store</h1>
7+
<div align="center">
68

7-
<p align="center">
8-
<a href="https://opensource.org/licenses/Apache-2.0"><img alt="License" src="https://img.shields.io/badge/License-Apache%202.0-blue.svg"/></a>
9-
<a href="https://kotlinlang.org"><img alt="Kotlin" src="https://img.shields.io/badge/Kotlin-Multiplatform-7F52FF.svg"/></a>
10-
<a href="#"><img alt="Platforms" src="https://img.shields.io/badge/Platforms-Android%20%7C%20Desktop-brightgreen"/></a>
11-
<a href="https://github.com/rainxchzed/Github-Store/releases">
12-
<img alt="Release" src="https://img.shields.io/github/v/release/rainxchzed/Github-Store?label=Release&logo=github"/>
13-
</a>
14-
<a href="https://github.com/rainxchzed/Github-Store/stargazers">
15-
<img alt="GitHub stars" src="https://img.shields.io/github/stars/rainxchzed/Github-Store?style=social"/>
16-
</a>
17-
<img alt="Compose Multiplatform" src="https://img.shields.io/badge/Compose-Multiplatform-4285F4?logo=jetpackcompose&logoColor=white"/>
18-
<img alt="Koin" src="https://img.shields.io/badge/DI-Koin-3C5A99?logo=kotlin&logoColor=white"/>
19-
</p>
9+
# GitHub Store
2010

21-
<p align="center">
22-
<a href="/docs/README-RU.md" target="_blank"> Русский </a> | <a href="/README.md" target="_blank"> English </a> | <a href="/docs/README-ES.md" target="_blank"> Español </a> | <a href="/docs/README-FR.md" target="_blank"> Français </a> | <a href="/docs/README-KR.md" target="_blank"> 한국어 </a> | <a href="/docs/README-ZH.md" target="_blank">中文</a> | <a href="/docs/README-JA.md" target="_blank">日本語</a> | <a href="/docs/README-PL.md" target="_blank">Polski</a>
23-
</p>
11+
</div>
12+
13+
</br>
2414

2515
<p align="center">
26-
GitHub Store is a cross‑platform “play store” for GitHub releases.
27-
It discovers repositories that ship real installable binaries and lets you install, track, and update them across platforms from one place.
16+
<img alt="API" src="https://img.shields.io/badge/Api%2024+-50f270?logo=android&logoColor=black&style=for-the-badge"/></a>
17+
<img alt="Kotlin" src="https://img.shields.io/badge/Kotlin-Multiplatform-a503fc?logo=kotlin&logoColor=white&style=for-the-badge"/></a>
18+
<img alt="Compose Multiplatform" src="https://img.shields.io/static/v1?style=for-the-badge&message=Compose+Multiplatform&color=4285F4&logo=Jetpack+Compose&logoColor=FFFFFF&label="/></a>
19+
<img alt="material" src="https://custom-icon-badges.demolab.com/badge/material%20you-lightblue?style=for-the-badge&logoColor=333&logo=material-you"/></a>
20+
</br>
21+
</br>
22+
23+
<img src="https://img.shields.io/github/downloads/rainxchzed/GitHub-Store/total?color=aeff4d&style=for-the-badge&logo=data%3Aimage%2Fsvg%2Bxml%3Bbase64%2CPHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAyNCAyNCI+PHRpdGxlPmRvd25sb2FkPC90aXRsZT48cGF0aCBkPSJNNSwyMEgxOVYxOEg1TTE5LDlIMTVWM0g5VjlINUwxMiwxNkwxOSw5WiIgZmlsbD0id2hpdGUiIC8+PC9zdmc+&label=Downloads&labelColor=4b731a"/>
24+
25+
<a href="https://github.com/rainxchzed/Github-Store/stargazers">
26+
<img src="https://img.shields.io/github/stars/rainxchzed/Github-Store?color=ffff00&style=for-the-badge&labelColor=a1a116&logo=data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAyNCAyNCI+PHRpdGxlPnN0YXI8L3RpdGxlPjxwYXRoIGQ9Ik0xMiwxNy4yN0wxOC4xOCwyMUwxNi41NCwxMy45N0wyMiw5LjI0TDE0LjgxLDguNjJMMTIsMkw5LjE5LDguNjJMMiw5LjI0TDcuNDUsMTMuOTdMNS44MiwyMUwxMiwxNy4yN1oiIGZpbGw9IndoaXRlIiAvPjwvc3ZnPg=="/>
27+
</a>
28+
29+
<img src="https://img.shields.io/badge/45K+-Users-8ce2ff?style=for-the-badge&logo=data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAyNCAyNCI+PHRpdGxlPmFjY291bnQtZ3JvdXA8L3RpdGxlPjxwYXRoIGQ9Ik0xMiwxMi43NUM3LDEyLjc1IDMsMTMuMzUgMywxNi4yNVYxOEgyMVYxNi4yNUMyMSwxMy4zNSAxNywxMi43NSAxMiwxMi43NU0xNyw3QTE3LDE3IDAgMCwxIDE3LDdNMjEsMTYuMjVWMThIMjRWMTYuMjVDMjQsMTQuNDMgMjEuNSwxMy44NyAxOSwxMy41QzIwLjEyLDE0LjEgMjEsMTUgMjEsMTYuMjVNMiw3QTIsMiAwIDAsMSA0LDVIMjBBMiwyIDAgMCwxIDIyLDdBMiwyIDAgMCwxIDIwLDlINEEyLDIgMCAwLDEgMiw3TTEyLDEwQTMsMyAwIDAsMSA5LDdBMywzIDAgMCwxIDEyLDRBMywzIDAgMCwxIDE1LDdBMywzIDAgMCwxIDEyLDEwWiIgZmlsbD0id2hpdGUiIC8+PC9zdmc+&labelColor=0782ab"/>
30+
31+
</br>
32+
</br>
33+
34+
<a href="https://github.com/rainxchzed/Github-Store/releases/latest">
35+
<img src="https://img.shields.io/github/v/release/rainxchzed/Github-Store?color=a1168e&include_prereleases&logo=github&style=for-the-badge&labelColor=700f63"/>
36+
</a>
37+
38+
<a href="https://f-droid.org/packages/zed.rainxch.githubstore">
39+
<img src="https://img.shields.io/f-droid/v/zed.rainxch.githubstore?color=a1168e&include_prereleases&logo=FDROID&style=for-the-badge&labelColor=700f63"/>
40+
</a>
41+
42+
</br>
43+
</br>
44+
45+
<a href="https://hellogithub.com/en/repository/rainxchzed/Github-Store" target="_blank">
46+
<img src="https://abroad.hellogithub.com/v1/widgets/recommend.svg?rid=rainxchzed%2FGithub-Store&claim_uid=&theme=dark" alt="Featured｜HelloGitHub" style="width: 250px; height: 54px;" width="250" height="54" />
47+
</a>
48+
2849
</p>
2950

30-
<p align="center">
31-
<img src="screenshots/banner.png" />
51+
<div align="center">
52+
53+
# 🗺️ Project Overview
54+
55+
GitHub Store is a cross-platform app store for GitHub releases, designed to simplify discovering and installing open-source software. It automatically detects installable binaries (APK, EXE, DMG, AppImage, DEB, RPM), provides one-click installation, tracks updates, and presents repository information in a clean, app-store style interface.
56+
57+
Built with Kotlin Multiplatform and Compose Multiplatform for Android and Desktop platforms.
58+
59+
</div>
60+
61+
<p align="middle">
62+
<img src="./screenshots/banner.jpeg" width="99%" />
63+
<img src="./screenshots/01.jpg" width="18%" />
64+
<img src="./screenshots/02.jpg" width="18%" />
65+
<img src="./screenshots/03.jpg" width="18%" />
66+
<img src="./screenshots/04.jpg" width="18%" />
67+
<img src="./screenshots/05.jpg" width="18%" />
3268
</p>
3369

34-
#### All screenshots can be found in [screenshots/](screenshots/) folder.
70+
<div align="center">
3571

36-
---
72+
# 📔 Wiki & Resources
3773

38-
## 📋 Legal
74+
Check out GitHub Store [Wiki](https://github.com/rainxchzed/Github-Store/wiki) for FAQ and useful information
3975

4076
**Privacy Policy:** [openhub-store.github.io/privacy-policy](https://openhub-store.github.io/privacy-policy/)
4177

42-
**Disclaimer:** GitHub Store is an independent, open-source project not affiliated with GitHub, Inc. The name describes the app's functionality (discovering GitHub releases from the GitHub platform) and does not imply trademark ownership or association. GitHub® is a registered trademark of GitHub, Inc.
78+
</div>
4379

4480
---
4581

46-
<img src="/screenshots/preview.gif" align="right" width="320"/>
82+
<div align="center">
4783

48-
## ✨ What is GitHub Store?
84+
### 📋 Legal Notice
4985

50-
GitHub Store is a Kotlin Multiplatform app (Android + Desktop) that turns GitHub releases into a
51-
clean, app‑store style experience:
86+
GitHub Store is an independent, open-source project not affiliated with GitHub, Inc.
87+
The name describes the app's functionality (discovering GitHub releases) and does not imply trademark ownership.
88+
GitHub® is a registered trademark of GitHub, Inc.
5289

53-
- Only shows repositories that actually provide installable assets (APK, EXE, DMG, AppImage, DEB, RPM, etc.).
54-
- Detects your platform and surfaces the correct installer.
55-
- Always installs from the latest published release, highlights its changelog, and can notify you when updates are available for installed apps (on Android).
56-
- Presents a polished details screen with stats, README, and developer info.
90+
</div>
5791

5892
---
5993

60-
[FAQ](https://github.com/rainxchzed/Github-Store/wiki/FAQ)
94+
<div align="center">
6195

62-
---
96+
# 🔃 Download
6397

64-
## 🔃 Download
98+
</div>
6599

100+
<p align="center">
66101
<a href="https://github.com/rainxchzed/Github-Store/releases">
67-
<image src="https://i.ibb.co/q0mdc4Z/get-it-on-github.png" height="80"/>
68-
</a>
69-
102+
<img src="https://i.ibb.co/q0mdc4Z/get-it-on-github.png" height="80"/>
103+
</a>
70104
<a href="https://f-droid.org/en/packages/zed.rainxch.githubstore/">
71-
<image src="https://f-droid.org/badge/get-it-on.png" height="80"/>
72-
</a>
73-
105+
<img src="https://f-droid.org/badge/get-it-on.png" height="80"/>
106+
</a>
107+
</p>
108+
74109
> [!IMPORTANT]
75-
> On macOS, you may see a warning that Apple cannot verify GitHub Store is free of malware. This
76-
> happens because the app is distributed outside the App Store and is not notarized yet. You can allow
77-
> it via System Settings → Privacy & Security → Open Anyway.
110+
> **macOS Users:** You may see a warning that Apple cannot verify GitHub Store. This happens because the app is distributed outside the App Store and is not notarized yet. Allow it via System Settings → Privacy & Security → Open Anyway.
111+
112+
---
113+
114+
<div align="center">
78115

79-
## 🏆 Featured In
116+
# 🏆 Featured In
80117

118+
</div>
119+
120+
<p align="center">
81121
<a href="https://www.youtube.com/@howtomen">
82-
<img src="https://img.shields.io/badge/Featured%20by-HowToMen-red?logo=youtube" alt="Featured by HowToMen">
122+
<img src="https://img.shields.io/badge/HowToMen-red?style=for-the-badge&logo=youtube&logoColor=white" alt="Featured by HowToMen">
83123
</a>
124+
</br>
125+
<strong>HowToMen:</strong> <a href="https://www.youtube.com/watch?v=7favc9MDedQ">Top 20 Best Android Apps 2026</a> | <a href="https://www.youtube.com/watch?v=VR-MEwPDw4k">Top 12 App Stores that are Better than Google Play Store </a>
126+
</br>
127+
<strong>HelloGitHub:</strong> <a href="https://hellogithub.com/en/repository/rainxchzed/Github-Store">Featured Project</a>
128+
</p>
129+
130+
---
84131

85-
- **HowToMen**: [Top 20 Best Android Apps 2026](https://www.youtube.com/watch?v=7favc9MDedQ)
86-
- **Hello Github**: [Featured on Hello Github](https://hellogithub.com/en/repository/rainxchzed/Github-Store)
132+
<img src="./screenshots/preview.gif" align="right" width="320" />
87133

88134
## 🚀 Features
89135

0 commit comments

Comments
 (0)