Merge pull request #83 from CompassMB/features

Included additional sections and app dependency updates

Author: MubarakNative

Featured.md

@@ -0,0 +1,28 @@
+##  Featured
+
+Trusted by developers worldwide, **MBCompass** has received significant recognition across the Android and open-source communities:
+
+<p align="center">
+  <a href="https://www.producthunt.com/products/mbcompass/launches/mbcompass">
+  <img src="https://github.com/CompassMB/MBCompass-site/blob/main/assets/img/ph_400_140.png?raw=true" alt="Product Hunt" style="margin-right: 10px;" />
+  </a>
+
+  <a href="https://news.ycombinator.com/item?id=44155741">
+  <img src="https://github.com/CompassMB/MBCompass-site/blob/main/assets/img/ychackernews_400_100.png?raw=true" alt="Hacker News" style="margin-right: 10px;" />
+  </a>
+
+  <a href="https://x.com/MubarakNative/status/1944745544905285893">
+  <img src="https://github.com/CompassMB/MBCompass-site/blob/main/assets/img/android-weekly_400_100.png?raw=true" style="margin-right: 10px;" alt="Android Weekly" />
+  </a>
+</p>
+
+
+<p align="center">
+
+- Ranked **#13 Product of the Day** on [Product Hunt](https://www.producthunt.com/products/mbcompass) with #1
+- Topped the <strong>#1 trending post</strong> in <a href="https://www.linkedin.com/feed/update/urn:li:activity:7359285672341315585/">Product Hunt Forums</a><br>
+- Made it to the **front page of [Hacker News](https://news.ycombinator.com/item?id=44155741)**
+- Featured in **two consecutive issues** of [Android Weekly](https://x.com/MubarakNative/status/1944745544905285893)
+- and featured on many [indie-communies]("https://www.google.com/search?q=MBCompass").
+</p>
+

README.md

@@ -35,9 +35,6 @@
 </h4>
 
 <div align="center" style="display: flex; justify-content: center; align-items: flex-start; gap: 12px; flex-wrap: wrap;">
-  <a href="https://www.producthunt.com/products/mbcompass?embed=true..." target="_blank">
-    <img src="https://api.producthunt.com/widgets/embed-image/v1/featured.svg?post_id=980786&theme=dark&t=1750390503058" width="250" height="54" alt="MBCompass on Product Hunt" />
-  </a>
   <a href="https://f-droid.org/app/com.mubarak.mbcompass">
     <img src="https://fdroid.gitlab.io/artwork/badge/get-it-on.png" width="170" alt="Get it on F-Droid"/>
   </a>
@@ -48,10 +45,11 @@
 
 ## About
 
-MBCompass is a simple yet feature-rich compass app for Android, built with Jetpack Compose. It uses the device’s magnetometer and accelerometer to provide real-time geomagnetic field updates. Designed with Android Lifecycle in mind, In general, a **modern and efficient compass**.
+**MBCompass** is a modern, free, and open-source compass and navigation app without **ads**, **IAP**, or **tracking**. Built with **Jetpack Compose**, it supports compass and navigation features while being **lightweight** and simple.
 
-> Most compass apps are either too basic or bloated with ads.  
-> **MBCompass** was created to fix that: lightweight, accurate, and ad-free.
+> Not just a compass. Not a map app.
+>
+> MBCompass bridges the gap between a **compass** and a **full navigation app** - shows direction and live location without using hundreds of MBs of storage or privacy trade-offs.
 
 ---
 
@@ -65,22 +63,31 @@ MBCompass is a simple yet feature-rich compass app for Android, built with Jetpa
   <img width="250" src="fastlane/metadata/android/en-US/images/phoneScreenshots/3.png" />
   <img width="250" src="fastlane/metadata/android/en-US/images/phoneScreenshots/4.png" />
 </p>
-<p align="center">
-  <img width="250" src="fastlane/metadata/android/en-US/images/phoneScreenshots/5.png" />
-  <img width="250" src="fastlane/metadata/android/en-US/images/phoneScreenshots/6.png" />
-</p>
 
 ## Features ✨
 
-- Magnetic north-based [azimuths](https://en.wikipedia.org/wiki/Azimuth).
-- Ability to show the user's current location using [OpenStreetMap](https://openstreetmap.org).
-- Light / Dark Theme support.
-- Display Magnetic Strength in µT.
-- Keep the screen on support.
+- Shows clear cardinal direction and magnetic azimuths.
+- Displays magnetic strength in µT.
+- Live GPS location tracking on OpenStreetMap.
+- Sensor fusion for improved accuracy (accelerometer, magnetometer, gyroscope).
+- Light and dark theme support controlled via Settings.
+- Keeps screen on during navigation.
 - Landscape orientation support.
-- Smooth compass rotation.
-- Sensor fusion: Combines (Accelerometer, Magnetometer, and Gyroscope) for better accuracy.
-- No annoying ads or in-app purchases.
+- Built with Jetpack Compose and Material Design.
+- Runs on Android 5.0+
+- No ads, no in-app purchases, no tracking.
+- [Find more on the website](https://compassmb.github.io/MBCompass-site/#features)
+
+## Recognition 🌟
+
+MBCompass has gained recognition from the global developer community:
+
+-  #13 Product of the Day on Product Hunt
+-  Featured in two consecutive issues of Android Weekly
+-  Reached the front page of Hacker News
+
+[See full highlights](./Featured.md)
+
 
 ##  Permissions 🔐
 
@@ -90,6 +97,17 @@ MBCompass is a simple yet feature-rich compass app for Android, built with Jetpa
 
 Contributions are welcome! If you encounter bugs or have feature suggestions, please open an issue or submit a pull request. See [Contributing Guidelines](CONTRIBUTING.md) for details.
 
+## Support 💖
+
+Open-source projects couldn't survive in the long run without donations or funding.
+
+MBCompass is a fully open-source project - free of ads, trackers, or in-app purchases.
+If you find it useful, consider supporting its continued development and maintenance:
+
+Find more info on [MBCompass page](https://compassmb.github.io/MBCompass-site/donate.html)
+
+Your support helps ensure the project stays sustainable and continues to improve for everyone. Thank you!
+
 ## License 📄
 
 [![GNU GPLv3 Image](https://www.gnu.org/graphics/gplv3-127x51.png)](http://www.gnu.org/licenses/gpl-3.0.en.html)

app/src/main/java/com/mubarak/mbcompass/ui/settings/SettingsScreen.kt

@@ -67,6 +67,7 @@ import com.mubarak.mbcompass.ui.theme.spacingSmall
 import com.mubarak.mbcompass.utils.Const.APP_PAGE
 import com.mubarak.mbcompass.utils.Const.AUTHOR_EMAIL
 import com.mubarak.mbcompass.utils.Const.LICENSE_PAGE
+import com.mubarak.mbcompass.utils.Const.SUPPORT_PAGE
 import com.mubarak.mbcompass.utils.ThemeConfig
 
 @Composable
@@ -92,6 +93,9 @@ fun SettingsScreen(
         onLicensesClicked = {
             uriHandler.openUri(LICENSE_PAGE)
         },
+        onSupportClicked = {
+            uriHandler.openUri(SUPPORT_PAGE)
+        },
         onSourceClicked = {
             uriHandler.openUri(APP_PAGE)
         }
@@ -105,6 +109,7 @@ fun SettingsScreen(
     onBackClicked: () -> Unit,
     onThemeOptionClicked: (String) -> Unit,
     onAuthorPageClicked: () -> Unit,
+    onSupportClicked: () -> Unit,
     onLicensesClicked: () -> Unit,
     onSourceClicked: () -> Unit
 ) {
@@ -132,6 +137,7 @@ fun SettingsScreen(
             onThemeItemClicked = { isThemeDialogVisible = true },
             onLicensesClicked = onLicensesClicked,
             onAuthorPageClicked = onAuthorPageClicked,
+            onSupportClicked = onSupportClicked,
             onSourceClicked = onSourceClicked
         )
         ThemeDialog(
@@ -151,6 +157,7 @@ private fun SettingsList(
     onThemeItemClicked: () -> Unit,
     onAuthorPageClicked: () -> Unit = {},
     onLicensesClicked: () -> Unit = {},
+    onSupportClicked: () -> Unit = {},
     onSourceClicked: () -> Unit = {},
 ) {
     Box(
@@ -202,6 +209,14 @@ private fun SettingsList(
                     onClick = onLicensesClicked,
                 )
             }
+            item(key = "__supportItem") {
+                SettingsItem(
+                    title = stringResource(R.string.support),
+                    icon = R.drawable.icon_support_24,
+                    subtitle = stringResource(R.string.donate),
+                    onClick = onSupportClicked,
+                )
+            }
             item(key = "__sourcecodeItem") {
                 SettingsItem(
                     title = stringResource(R.string.source_code),
@@ -353,6 +368,7 @@ fun SettingsScreenPreview() {
             onBackClicked = {},
             onThemeOptionClicked = {},
             onLicensesClicked = {},
+            onSupportClicked = {},
             onAuthorPageClicked = {},
             onSourceClicked = {}
         )

app/src/main/java/com/mubarak/mbcompass/utils/Const.kt

@@ -1,7 +1,8 @@
 package com.mubarak.mbcompass.utils
 
 object Const {
-    const val APP_PAGE = "https://github.com/MubarakNative/MBCompass"
+    const val APP_PAGE = "https://github.com/CompassMB/MBCompass"
     const val LICENSE_PAGE = "https://www.gnu.org/licenses/gpl-3.0.txt"
+    const val SUPPORT_PAGE = "https://compassmb.github.io/MBCompass-site/donate.html"
     const val AUTHOR_EMAIL = "dev.mubarakbasha@gmail.com"
 }

app/src/main/res/drawable/icon_support_24.xml

@@ -0,0 +1,5 @@
+<vector xmlns:android="http://schemas.android.com/apk/res/android" android:height="24dp" android:tint="#000000" android:viewportHeight="960" android:viewportWidth="960" android:width="24dp">
+      
+    <path android:fillColor="@android:color/white" android:pathData="M640,520L474,358Q443,328 421.5,291.5Q400,255 400,212Q400,157 438.5,118.5Q477,80 532,80Q564,80 592,93.5Q620,107 640,130Q660,107 688,93.5Q716,80 748,80Q803,80 841.5,118.5Q880,157 880,212Q880,255 859,291.5Q838,328 807,358L640,520ZM640,408L749,301Q768,282 784,260.5Q800,239 800,212Q800,190 785,175Q770,160 748,160Q734,160 721.5,165.5Q709,171 700,182L640,254L580,182Q571,171 558.5,165.5Q546,160 532,160Q510,160 495,175Q480,190 480,212Q480,239 496,260.5Q512,282 531,301L640,408ZM280,740L558,816L796,742Q791,733 781.5,726.5Q772,720 760,720L558,720Q531,720 515,718Q499,716 482,710L389,679L411,601L492,628Q509,633 532,636Q555,639 600,640L600,640Q600,640 600,640Q600,640 600,640Q600,629 593.5,619Q587,609 578,606L344,520Q344,520 344,520Q344,520 344,520L280,520L280,740ZM40,880L40,440L344,440Q351,440 358,441.5Q365,443 371,445L606,532Q639,544 659.5,574Q680,604 680,640L760,640Q810,640 845,673Q880,706 880,760L880,800L560,900L280,822L280,822L280,880L40,880ZM120,800L200,800L200,520L120,520L120,800ZM640,254L640,254Q640,254 640,254Q640,254 640,254Q640,254 640,254Q640,254 640,254Q640,254 640,254Q640,254 640,254L640,254L640,254Q640,254 640,254Q640,254 640,254Q640,254 640,254Q640,254 640,254Q640,254 640,254Q640,254 640,254Z"/>
+    
+</vector>

app/src/main/res/values/strings.xml

@@ -44,4 +44,6 @@
     <string name="developer">Mubarak Basha</string>
     <string name="source_code">Source code</string>
     <string name="github">GitHub</string>
+    <string name="support">Support Us</string>
+    <string name="donate">Donate to keep this app free and ad-free</string>
 </resources>