Skip to content

Commit e5f4fe2

Browse files
christocracyclaude
andcommitted
docs: consistent README — Licensing after Documentation, Examples links, SDK availability panel
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent 387e56d commit e5f4fe2

1 file changed

Lines changed: 20 additions & 17 deletions

File tree

README.md

Lines changed: 20 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,45 @@
11
<p align="center">
2-
<img src="assets/images/panel-all.svg" alt="Background Geolocation SDK" width="700">
2+
<img src="https://raw.githubusercontent.com/transistorsoft/assets/master/images/logos/transistor/transistor-logo-panel-all.svg" alt="Background Geolocation SDK" width="635">
33
</p>
44

55
# Background Geolocation SDK — iOS & Android
66

77
The most sophisticated background **location-tracking & geofencing** SDK with battery-conscious motion-detection intelligence for **iOS** and **Android**.
88

9+
The SDK uses **motion-detection** APIs (accelerometer, gyroscope, magnetometer) to detect when the device is *moving* or *stationary*:
10+
11+
- **Moving** — location recording starts automatically at the configured `distanceFilter` (metres)
12+
- **Stationary** — location services turn off automatically to conserve battery
13+
914
---
1015

1116
## :books: Documentation
1217

13-
### <img src="assets/images/platforms/kotlin.svg" width="20" height="20"> Kotlin
14-
- [Setup](https://docs.transistorsoft.com/kotlin/setup/)
15-
- [API Reference](https://docs.transistorsoft.com/kotlin/BGGeo/)
16-
1718
### <img src="assets/images/platforms/swift.svg" width="20" height="20"> Swift
1819
- [Setup](https://docs.transistorsoft.com/swift/setup/)
1920
- [API Reference](https://docs.transistorsoft.com/swift/BGGeo/)
21+
- [Examples](https://docs.transistorsoft.com/swift/examples/)
22+
23+
### <img src="assets/images/platforms/kotlin.svg" width="20" height="20"> Kotlin
24+
- [Setup](https://docs.transistorsoft.com/kotlin/setup/)
25+
- [API Reference](https://docs.transistorsoft.com/kotlin/BGGeo/)
26+
- [Examples](https://docs.transistorsoft.com/kotlin/examples/)
2027

2128
---
2229

23-
## How it works
30+
## :key: Licensing
2431

25-
The SDK uses **motion-detection** APIs (accelerometer, gyroscope, magnetometer) to detect when the device is *moving* or *stationary*:
32+
> [!TIP]
33+
> The SDK is **fully functional in `DEBUG` builds** — no license required. Try before you buy.
2634
27-
- **Moving** — location recording starts automatically at the configured `distanceFilter` (metres)
28-
- **Stationary** — location services turn off automatically to conserve battery
35+
A license is required only for **`RELEASE` builds** on Android.
36+
[Purchase a license](https://shop.transistorsoft.com/products/background-geolocation-for-native-apps)
2937

3038
---
3139

32-
## SDK availability
40+
## 📦 SDK availability
41+
42+
<img src="https://raw.githubusercontent.com/transistorsoft/assets/master/images/logos/transistor/transistor-logo-panel-all.svg" width="300">
3343

3444
| Platform | Package |
3545
|---|---|
@@ -43,11 +53,4 @@ The SDK uses **motion-detection** APIs (accelerometer, gyroscope, magnetometer)
4353

4454
---
4555

46-
## License
47-
48-
The Android SDK requires a license for **release** builds.
49-
[Purchase a license](https://shop.transistorsoft.com/products/background-geolocation-for-native-apps) — debug builds work without one.
50-
51-
---
52-
5356
MIT © [Transistor Software](https://www.transistorsoft.com)

0 commit comments

Comments
 (0)