Skip to content

Commit e9bdfe4

Browse files
authored
Merge pull request #862 from mjaakko/update_docs_google_play
Update documentation to reflect that NeoStumbler is now available on Google Play
2 parents f0a59d4 + aab6513 commit e9bdfe4

File tree

3 files changed

+37
-11
lines changed

3 files changed

+37
-11
lines changed

README.md

Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,13 @@
1414
height="80">
1515
</a>
1616

17+
<a href="https://play.google.com/store/apps/details?id=xyz.malkki.neostumbler.gplay" style="float:right;">
18+
<img
19+
alt="Get it on Google Play"
20+
src="https://play.google.com/intl/en_us/badges/images/generic/en_badge_web_generic.png"
21+
height="80">
22+
</a>
23+
1724
# NeoStumbler
1825

1926
NeoStumbler is an Android application for collecting locations of cell towers, Wi-Fi access points
@@ -24,12 +31,13 @@ Services) such as [beaconDB](https://beacondb.net/).
2431
## Downloads
2532

2633
> [!TIP]
27-
> See the [user guide](docs/user_guide.md) for more details on how to use NeoStumbler
34+
> See the [user guide](https://neostumbler.malkki.xyz/user_guide/) for more details on how to use NeoStumbler
2835
29-
There are two variants available:
36+
There are three variants available:
3037

31-
* *full* - includes all features
32-
* *fdroid* - does not include closed components (i.e. Google Play Services)
38+
* *fullDefault* - includes all features
39+
* *fullGplay* - includes all features (except automatic scanning) and complies with Google Play store policies
40+
* *fdroidDefault* - does not include closed components (i.e. Google Play Services)
3341
* Features missing:
3442
* [Fused location provider](https://developers.google.com/location-context/fused-location-provider)
3543
* Automatic scanning based
@@ -56,6 +64,10 @@ The *full* variant is available
5664
from [Accrescent](https://accrescent.app/app/xyz.malkki.neostumbler). The advantage of using
5765
Accrescent is that only the assets needed for your device are downloaded.
5866

67+
A modified version of the *full* variant is also available
68+
on [Google Play](https://play.google.com/store/apps/details?id=xyz.malkki.neostumbler.gplay). This version does not
69+
include the automatic scanning feature and contains some minor quirks to comply with Google Play policies.
70+
5971
## Features
6072

6173
* Supports latest Android versions
@@ -73,7 +85,7 @@ The application has three product flavors:
7385
* `fdroidDefault` - no closed components, features dependent on closed-source components (i.e.
7486
Google Play Services) are not included
7587
* `fullDefault` - includes closed components, no features missing
76-
* `fullGplay` - *work in progress*, based on `fullDefault`, but has some minor differences to make
88+
* `fullGplay` - based on `fullDefault`, but has some minor differences to make
7789
it compliant with Google Play requirements
7890

7991
### Building

docs/user_guide.md

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,22 +10,31 @@ implementations with the same API are also usable.
1010

1111
## 1. Installing
1212

13-
There are two variants available:
13+
There are three variants available:
1414

15-
* **full** - includes all features, uses closed components (i.e. Google Play Services)
16-
* **fdroid** - does not use closed components, some features missing
15+
* **fullDefault** - includes all features, uses closed components (i.e. Google Play Services)
16+
* **fullGplay** - same as *fullDefault*, except does not have the automatic scanning feature and contains some quirks to
17+
comply with Google Play store policies
18+
* **fdroidDefault** - does not use closed components, some features missing
1719

18-
The **full** variant can be downloaded from:
20+
The *full* variants are only useful if you have Google Play services (or a compatible alternative for Google Play
21+
services) on your device.
22+
23+
The **fullDefault** variant can be downloaded from:
1924

2025
* [Accrescent](https://accrescent.app/app/xyz.malkki.neostumbler)
2126
* [GitHub releases](https://github.com/mjaakko/NeoStumbler/releases)
2227

23-
The **fdroid** variant can be downloaded from:
28+
The **fdroidDefault** variant can be downloaded from:
2429

2530
* [F-Droid](https://f-droid.org/packages/xyz.malkki.neostumbler.fdroid/)
2631
* [IzzyOnDroid](https://apt.izzysoft.de/fdroid/index/apk/xyz.malkki.neostumbler.fdroid)
2732
* [GitHub releases](https://github.com/mjaakko/NeoStumbler/releases)
2833

34+
The **fullGplay** variant can be downloaded from:
35+
36+
* [Google Play](https://play.google.com/store/apps/details?id=xyz.malkki.neostumbler.gplay)
37+
2938
The versions marked as *pre-release* are beta versions of the next version of NeoStumbler.
3039

3140
If you're downloading NeoStumbler from GitHub releases, you can use a tool such

website/src/pages/index.astro

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,10 +29,15 @@ import Layout from '../layouts/Layout.astro';
2929
image="https://fdroid.gitlab.io/artwork/badge/get-it-on.png"
3030
alt="Get it on F-Droid"/>
3131

32-
<DownloadBadge
32+
<DownloadBadge
3333
url="https://accrescent.app/app/xyz.malkki.neostumbler"
3434
image="https://accrescent.app/badges/get-it-on.png"
3535
alt="Get it on Accrescent" />
36+
37+
<DownloadBadge
38+
url="https://play.google.com/store/apps/details?id=xyz.malkki.neostumbler.gplay"
39+
image="https://play.google.com/intl/en_us/badges/images/generic/en_badge_web_generic.png"
40+
alt="Get it on Google Play" />
3641
</div>
3742
</section>
3843
</div>

0 commit comments

Comments
 (0)