Skip to content

Commit c8b080c

Browse files
committed
feat(docs): update README with new features and architectural improvements
This commit updates the README to reflect significant enhancements across the application, including the new release browser, improved app management capabilities, and expanded platform support. - **feat(discovery)**: Added auto-scroll behavior for categories and overhaul of the search system with relevance ranking. - **feat(releases)**: Introduced a release picker to browse and install from any release version, moving beyond "latest-only" support. - **feat(details)**: Added deep linking support, developer profile screens, and a share action. - **feat(management)**: Documented new app management features including open, uninstall, and downgrade actions, alongside APK architecture matching for Android. - **feat(network)**: Added documentation for dynamic proxy support and the enhanced caching system. - **i18n**: Listed 12 newly supported languages for localization. - **feat(ux)**: Added details for Android-specific UI enhancements (splash screen, adaptive icons) and expanded Linux format support (AppImage). - **docs**: Refined the "How it works" and "Key benefits" sections to align with current functionality.
1 parent eb73817 commit c8b080c

1 file changed

Lines changed: 37 additions & 15 deletions

File tree

README.md

Lines changed: 37 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -153,22 +153,40 @@ GitHub® is a registered trademark of GitHub, Inc.
153153
- Home sections for “Trending”, “Recently Updated”, and “New” projects with time‑based filters.
154154
- Only repos with valid installable assets are shown.
155155
- Platform‑aware topic scoring so Android/desktop users see relevant apps first.
156+
- Auto‑scrolls to top when switching categories.
157+
- Overhauled search with improved relevance ranking and performance.
156158

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.
159+
- **Release browser & installs**
160+
- Release picker to browse and install from any release, not just the latest.
161+
- Fetches all releases for each repository.
162+
- Single “Install latest” action, plus an expandable list of all available releases and their installers.
163+
- Manual install option with automatic compatibility checks.
161164

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

169186
- **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.
187+
- Android: native splash screen, session expiration handling, and adaptive icon.
188+
- Desktop: Linux AppImage support prioritized alongside DEB and RPM formats.
189+
- Localized in 12 languages: English, Spanish, French, Japanese, Korean, Polish, Russian, Chinese, Bengali, Hindi, Italian, and Turkish.
172190

173191
---
174192

@@ -217,18 +235,22 @@ automatically—no manual submission required.
217235
- For candidate repos, calls `/repos/{owner}/{repo}/releases/latest`.
218236
- Checks the `assets` array for platform‑specific file extensions.
219237
- If no suitable asset is found, the repo is excluded from results.
238+
- Users can also browse all releases via the release picker.
220239

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

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

233255
---
234256

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

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.
265+
- **Always up to date**
266+
Installs default to the latest published release, with the option to browse and install from
267+
any previous release via the release picker.
246268

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

0 commit comments

Comments
 (0)