Skip to content

Commit f5dfa95

Browse files
authored
Merge pull request #282 from rainxchzed/readme-polish
2 parents 03df560 + 0808112 commit f5dfa95

1 file changed

Lines changed: 43 additions & 23 deletions

File tree

README.md

Lines changed: 43 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,9 @@ Built with Kotlin Multiplatform and Compose Multiplatform for Android and Deskto
6363

6464
</div>
6565

66+
> [!CAUTION]
67+
> Free and Open-Source Android is under threat. Google will turn Android into a locked-down platform, restricting your essential freedom to install apps of your choice. Make your voice heard – [keepandroidopen.org](https://keepandroidopen.org/).
68+
6669
<p align="middle">
6770
<img src="./screenshots/banner.jpeg" width="99%" />
6871
<img src="./screenshots/01.jpg" width="18%" />
@@ -150,25 +153,42 @@ GitHub® is a registered trademark of GitHub, Inc.
150153
## 🚀 Features
151154

152155
- **Smart discovery**
153-
- Home sections for “Trending”, “Recently Updated”, and “New” projects with time‑based filters.
156+
- Home sections for “Trending”, “Hot Release”, and “Most Popular” projects with time‑based filters.
154157
- Only repos with valid installable assets are shown.
155158
- Platform‑aware topic scoring so Android/desktop users see relevant apps first.
159+
- Overhauled search with improved relevance ranking and performance.
156160

157-
- **Latest‑release installs**
158-
- Fetches `/releases/latest` for each repo.
159-
- Shows only assets from the latest release.
160-
- Single “Install latest” action, plus an expandable list of all installers for that release.
161+
- **Release browser & installs**
162+
- Release picker to browse and install from any release, not just the latest.
163+
- Fetches all releases for each repository.
164+
- Single “Install latest” action, plus an expandable list of all available releases and their installers.
165+
- Manual install option with automatic compatibility checks.
161166

162167
- **Rich details screen**
163-
- App name, version, “Install latest” button.
168+
- App name, version, “Install latest” button, and share action.
164169
- Stars, forks, open issues.
165170
- Rendered README content (“About this app”).
166-
- Latest release notes (body) with markdown formatting.
171+
- Release notes with Markdown formatting for any selected release.
167172
- List of installers with platform labels and file sizes.
173+
- Deep linking support — open repository details directly via URL.
174+
- Developer profile screen to explore a developer’s repositories and activity.
175+
176+
- **App management**
177+
- Open, uninstall, and downgrade installed apps directly from GitHub Store.
178+
- Android: APK architecture matching (armv7/armv8), package monitoring, and update tracking.
179+
- Desktop (Windows/macOS/Linux): downloads installers to the user’s Downloads folder and opens them with the default handler.
180+
181+
- **Starred repositories**
182+
- Save and browse your starred GitHub repositories from within the app.
183+
184+
- **Network & performance**
185+
- Dynamic proxy support for configurable network routing.
186+
- Enhanced caching system for faster loading and reduced API usage.
168187

169188
- **Cross‑platform UX**
170-
- 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.
171-
- Desktop (Windows/macOS/Linux): downloads installers to the user’s Downloads folder and opens them with the default handler; no hidden temp locations.
189+
- Android: native splash screen, session expiration handling, and adaptive icon.
190+
- Desktop: Linux AppImage support prioritized alongside DEB and RPM formats.
191+
- Localized in 12 languages: English, Spanish, French, Japanese, Korean, Polish, Russian, Chinese, Bengali, Hindi, Italian, and Turkish.
172192

173193
---
174194

@@ -180,11 +200,7 @@ Your project can appear automatically if it follows these conditions:
180200
1. **Public repository on GitHub**
181201
- Visibility must be `public`.
182202

183-
2. **At least one published release**
184-
- Created via GitHub Releases (not only tags).
185-
- The latest release must not be a draft or prerelease.
186-
187-
3. **Installable assets in the latest release**
203+
2. **Installable assets in the latest release**
188204
- The latest release must contain at least one asset file with a supported extension:
189205
- Android: `.apk`
190206
- Windows: `.exe`, `.msi`
@@ -193,13 +209,13 @@ Your project can appear automatically if it follows these conditions:
193209
- GitHub Store ignores GitHub’s auto‑generated source artifacts (`Source code (zip)` /
194210
`Source code (tar.gz)`).
195211

196-
4. **Discoverable by search / topics**
212+
3. **Discoverable by search / topics**
197213
- Repositories are fetched via the public GitHub Search API.
198214
- Topic, language, and description help the ranking:
199215
- Android apps: topics like `android`, `mobile`, `apk`.
200216
- Desktop apps: topics like `desktop`, `windows`, `linux`, `macos`, `compose-desktop`,
201217
`electron`.
202-
- Having at least a few stars makes it more likely to appear under Popular/Updated/New sections.
218+
- Having at least a few stars makes it more likely to appear under Trending/Hot Release/Most Popular sections.
203219

204220
If your repo meets these conditions, GitHub Store can find it through search and show it
205221
automatically—no manual submission required.
@@ -217,18 +233,22 @@ automatically—no manual submission required.
217233
- For candidate repos, calls `/repos/{owner}/{repo}/releases/latest`.
218234
- Checks the `assets` array for platform‑specific file extensions.
219235
- If no suitable asset is found, the repo is excluded from results.
236+
- Users can also browse all releases via the release picker.
220237

221238
3. **Details screen**
222239
- Repository info: name, owner, description, stars, forks, issues.
223-
- Latest release: tag, published date, body (changelog), assets.
240+
- Release browser: browse any release with its tag, date, changelog, and assets.
224241
- README: loaded from the default branch and rendered as “About this app”.
242+
- Developer profile link and share action.
243+
- Accessible via deep links for direct navigation.
225244

226245
4. **Install flow**
227-
- When the user taps “Install latest”:
228-
- Picks the best matching asset for the current platform.
229-
- Streams the download.
246+
- When the user taps “Install latest” or selects a specific release:
247+
- Picks the best matching asset for the current platform (with architecture matching on Android).
248+
- Streams the download with caching support.
230249
- Delegates to the OS installer (APK installer on Android, default handler on desktop).
231250
- On Android, records the installation in a local database and uses package monitoring to keep the installed list in sync.
251+
- Supports open, uninstall, and downgrade actions for managed apps.
232252

233253
---
234254

@@ -240,9 +260,9 @@ automatically—no manual submission required.
240260
- **Knows what you installed**
241261
Tracks apps installed via GitHub Store (Android) and highlights when new releases are available, so you can update them without hunting through GitHub again.
242262

243-
- **Always the latest release**
244-
Installs are guaranteed to come from the latest published release; the changelog you see is
245-
exactly what you’re installing.
263+
- **Always up to date**
264+
Installs default to the latest published release, with the option to browse and install from
265+
any previous release via the release picker.
246266

247267
- **Uniform experience across platforms**
248268
Same UI and logic for Android and desktop, with platform‑native install behavior.

0 commit comments

Comments
 (0)