Skip to content

Commit dc4201e

Browse files
authored
Merge pull request #72 from rainxchzed/rainxchzed-patch-2
Revise README for improved feature descriptions
2 parents 3146bd0 + b5caaeb commit dc4201e

1 file changed

Lines changed: 23 additions & 11 deletions

File tree

README.md

Lines changed: 23 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,8 @@
1919
</p>
2020

2121
<p align="center">
22-
Github Store is a cross‑platform “play store” for GitHub releases.
23-
It discovers repositories that ship real installable binaries and lets you install the latest release in one click.
22+
Github Store is a cross‑platform “play store” for GitHub releases.
23+
It discovers repositories that ship real installable binaries and lets you install, track, and update them across platforms from one place.
2424
</p>
2525

2626
<p align="center">
@@ -38,9 +38,9 @@ It discovers repositories that ship real installable binaries and lets you insta
3838
Github Store is a Kotlin Multiplatform app (Android + Desktop) that turns GitHub releases into a
3939
clean, app‑store style experience:
4040

41-
- Only shows repositories that actually provide installable assets (APK, EXE, DMG, etc.).
41+
- Only shows repositories that actually provide installable assets (APK, EXE, DMG, AppImage, DEB, RPM, etc.).
4242
- Detects your platform and surfaces the correct installer.
43-
- Always installs from the **latest published release** and highlights its changelog.
43+
- Always installs from the latest published release, highlights its changelog, and can notify you when updates are available for installed apps (on Android).
4444
- Presents a polished details screen with stats, README, and developer info.
4545

4646
---
@@ -63,7 +63,7 @@ clean, app‑store style experience:
6363
## 🚀 Features
6464

6565
- **Smart discovery**
66-
- Home sections for “Popular”, “Recently Updated”, and “New” projects.
66+
- Home sections for “Trending”, “Recently Updated”, and “New” projects with time‑based filters.
6767
- Only repos with valid installable assets are shown.
6868
- Platform‑aware topic scoring so Android/desktop users see relevant apps first.
6969

@@ -80,11 +80,18 @@ clean, app‑store style experience:
8080
- List of installers with platform labels and file sizes.
8181

8282
- **Cross‑platform UX**
83-
- Android: opens APK downloads and hands off to the package installer.
84-
- Desktop (Windows/macOS/Linux): downloads to a configurable location and opens the file.
83+
- Android: opens APK downloads with the package installer, tracks installations in a local database, and shows them in a dedicated Apps screen with update indicators.
84+
- Desktop (Windows/macOS/Linux): downloads installers to the user’s Downloads folder and opens them with the default handler; no hidden temp locations.
85+
86+
- **Appearance & theming**
87+
- Material 3 design with **Material 3 Expressive** components on all platforms.
88+
- Material You dynamic color support on Android where available.
89+
- Optional AMOLED black mode for dark theme on OLED devices.
90+
91+
- **Safety & inspection (Android)**
92+
- Optional GitHub sign‑in via OAuth device flow for higher rate limits with minimal scopes.
93+
- “Open in AppManager” action to inspect an APK’s permissions and trackers before installing.
8594

86-
- **GitHub login & rate‑limit friendly**
87-
- Sign‑in with GitHub to use the user’s own 5,000 req/hour quota.
8895

8996
---
9097

@@ -105,7 +112,7 @@ Your project can appear automatically if it follows these conditions:
105112
- Android: `.apk`
106113
- Windows: `.exe`, `.msi`
107114
- macOS: `.dmg`, `.pkg`
108-
- Linux: `.deb`, `.rpm`
115+
- Linux: `.deb`, `.rpm`, `.AppImage`
109116
- Github Store ignores GitHub’s auto‑generated source artifacts (`Source code (zip)` /
110117
`Source code (tar.gz)`).
111118

@@ -144,6 +151,7 @@ automatically—no manual submission required.
144151
- Picks the best matching asset for the current platform.
145152
- Streams the download.
146153
- Delegates to the OS installer (APK installer on Android, default handler on desktop).
154+
- On Android, records the installation in a local database and uses package monitoring to keep the installed list in sync.
147155

148156
---
149157

@@ -164,6 +172,7 @@ automatically—no manual submission required.
164172
- [Ktor 3](https://ktor.io/) (HttpClient with OkHttp on Android, Java on Desktop)
165173
- [Kotlinx Serialization JSON](https://github.com/Kotlin/kotlinx.serialization).
166174
- [Kotlinx Datetime](https://github.com/Kotlin/kotlinx-datetime) for time handling
175+
- [Room](https://developer.android.com/jetpack/androidx/releases/room) + KSP for the installed apps database on Android.
167176

168177
- **Dependency injection**
169178
- [Koin 4](https://insert-koin.io/)
@@ -193,9 +202,12 @@ automatically—no manual submission required.
193202

194203
## ✅ Pros / Why use Github Store?
195204

196-
- **No more hunting through GitHub releases**
205+
- **No more hunting through GitHub releases**
197206
See only repos that actually ship binaries for your platform.
198207

208+
- **Knows what you installed**
209+
Tracks apps installed via Github Store (Android) and highlights when new releases are available, so you can update them without hunting through GitHub again.
210+
199211
- **Always the latest release**
200212
Installs are guaranteed to come from the latest published release; the changelog you see is
201213
exactly what you’re installing.

0 commit comments

Comments
 (0)