Update README

This commit is contained in:
Prem Nirmal
2026-06-27 11:37:18 +01:00
committed by GitHub
parent 096b19ce06
commit e967145ec4
+17 -21
View File
@@ -2,17 +2,14 @@
[![Build](https://github.com/premnirmal/StockTicker/workflows/Build/badge.svg)](https://github.com/premnirmal/StockTicker/actions) [![Unit tests](https://github.com/premnirmal/StockTicker/workflows/Run%20unit%20tests/badge.svg)](https://github.com/premnirmal/StockTicker/actions)
<a href="https://play.google.com/store/apps/details?id=com.github.premnirmal.tickerwidget" target="_blank">
<img src="https://play.google.com/intl/en_us/badges/images/generic/en-play-badge.png" alt="Get it on Google Play" height="90"/></a>
<img src="https://upload.wikimedia.org/wikipedia/commons/thumb/7/78/Google_Play_Store_badge_EN.svg/500px-Google_Play_Store_badge_EN.svg.png" alt="Get it on Google Play" height="40"/>
</a>
<a href="https://apps.apple.com/us/app/todaystocks/id993467855" target="_blank">
<img src="https://github.com/user-attachments/assets/109a051a-7d0d-492a-a6e5-efbc20ac4a96" alt="Available on the App Store" height="60"/></a>
<img src="https://developer.apple.com/assets/elements/badges/download-on-the-app-store.svg" alt="Available on the App Store" height="40"/>
</a>
<a href="https://f-droid.org/en/packages/com.github.premnirmal.tickerwidget/" target="_blank">
<img src="https://f-droid.org/badge/get-it-on.png" alt="Get it on F-Droid" height="90"/></a>
![](https://play-lh.googleusercontent.com/R9khJ5kNzXHUjO4BxNw1cNKTx62grZ7FtLRT_F2H0BhC99iuMWDxvuGTYvyydtqE3w=h400-rw)
![](https://play-lh.googleusercontent.com/uxQfuEmietfmyq4e-xNEAXfwtkWFE9iVbJYpMtc55yKqOYTv25ViSGS1dTf6qrncXIo=h400-rw)
![](https://play-lh.googleusercontent.com/fQZFK93aeUVMr0BDNIuk8Ol9i-HC4d7GCtk01VtKr2-qcdtpmR8gO3-DJMCPbTwsCA=h400-rw)
<img src="https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcQEslT1h9Dawi4R80LvhKKeLvCKNsi5nzvKmg&s" alt="Get it on F-Droid" height="40"/>
</a>
## App features
@@ -21,24 +18,23 @@
- Only performs automatic fetching of stocks during trading hours
- Displays price change and summary alerts
## iOS app
StockTicker also runs on iOS. The iOS app is a thin SwiftUI shell that hosts the same shared
Compose Multiplatform UI as Android, plus a native WidgetKit home-screen widget. It shares the
full business logic (networking, persistence, preferences, background refresh) and the in-app
screens (watchlist, trending, search, quote detail, settings) with Android via the `:shared`
module. See [`iosApp/README.md`](iosApp/README.md) for build instructions.
<img src="https://github.com/user-attachments/assets/75e65d1d-70ac-4464-a2f3-d9b3674d226c" height="400"/>
<img src="https://github.com/user-attachments/assets/cd0b7bae-26f3-44af-a3fc-339c76507471" height="400"/>
## Kotlin Multiplatform
This project has been migrated to Kotlin Multiplatform (KMP) with shared Compose Multiplatform
UI, so Android and iOS run from one shared codebase. Platform-agnostic code and the shared
in-app screens live in the `:shared` module (`androidTarget` + iOS targets), with thin
platform shells in `:app` (Android) and `iosApp` (iOS). See [MULTIPLATFORM.md](MULTIPLATFORM.md)
for the module layout and the history of the migration.
for the module layout and the history of the migration. The iOS app is a thin SwiftUI shell that hosts the same shared
Compose Multiplatform UI as Android, plus a native WidgetKit home-screen widget. It shares the
full business logic (networking, persistence, preferences, background refresh) and the in-app
screens (watchlist, trending, search, quote detail, settings) with Android via the `:shared`
module. See [`iosApp/README.md`](iosApp/README.md) for build instructions.
## Android
![](https://play-lh.googleusercontent.com/R9khJ5kNzXHUjO4BxNw1cNKTx62grZ7FtLRT_F2H0BhC99iuMWDxvuGTYvyydtqE3w=h400-rw)
<img src="https://i.postimg.cc/dvjnChBZ/Screenshot-20260627-113556.png" height="400"/>
<img src="https://github.com/user-attachments/assets/75e65d1d-70ac-4464-a2f3-d9b3674d226c" height="400"/>
<img src="https://github.com/user-attachments/assets/cd0b7bae-26f3-44af-a3fc-339c76507471" height="400"/>
## License