Skip to content

Commit ccf0ae2

Browse files
christocracyclaude
andcommitted
docs: move Licensing after Documentation; add Demo Server section to example README
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent bf391aa commit ccf0ae2

File tree

2 files changed

+45
-48
lines changed

2 files changed

+45
-48
lines changed

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,16 @@ The SDK uses **motion-detection** APIs (accelerometer, gyroscope, magnetometer)
3232

3333
---
3434

35+
## :key: Licensing
36+
37+
> [!TIP]
38+
> The SDK is **fully functional in `DEBUG` builds** — no license required. Try before you buy.
39+
40+
A license is required only for **`RELEASE` builds** on Android.
41+
[Purchase a license](https://shop.transistorsoft.com/products/react-native-background-geolocation)
42+
43+
---
44+
3545
## :open_file_folder: Example Apps
3646

3747
See [`/example`](example/README.md) — example apps are included in this repo.
@@ -52,14 +62,4 @@ See [`/example`](example/README.md) — example apps are included in this repo.
5262

5363
---
5464

55-
## :key: Licensing
56-
57-
> [!TIP]
58-
> The SDK is **fully functional in `DEBUG` builds** — no license required. Try before you buy.
59-
60-
A license is required only for **`RELEASE` builds** on Android.
61-
[Purchase a license](https://shop.transistorsoft.com/products/react-native-background-geolocation)
62-
63-
---
64-
6565
MIT © [Transistor Software](https://www.transistorsoft.com)

example/README.md

Lines changed: 35 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,49 +1,62 @@
11
# Example Apps
22

33
This directory contains example applications demonstrating different levels of
4-
usage of the
5-
[react-native-background-geolocation](https://github.com/transistorsoft/react-native-background-geolocation)
6-
SDK.
7-
8-
Each app is intended to showcase a specific learning path, from minimal
9-
integration to advanced, feature-rich usage.
4+
usage of the [react-native-background-geolocation](https://github.com/transistorsoft/react-native-background-geolocation) SDK.
105

116
---
127

13-
## Available Examples
8+
## Examples
149

15-
### Advanced Demo App
10+
### Advanced Demo
1611

1712
**Path:** `./Advanced`
1813

19-
A full-featured demonstration app showcasing advanced capabilities of the SDK,
20-
including:
14+
A full-featured demonstration app showcasing advanced capabilities of the SDK, including:
2115

2216
- Live map visualization
2317
- Real-time configuration editing
2418
- Circular and polygon geofences
2519
- Motion state management
2620
- Demo server registration and tracking
2721

28-
👉 See: [Advanced Demo App](./Advanced)
29-
30-
---
31-
32-
### HelloWorld Demo App
22+
### HelloWorld Demo
3323

3424
**Path:** `./HelloWorld`
3525

36-
A minimal, stripped-down demo app focused on core SDK concepts, including:
26+
A minimal, stripped-down demo focused on core SDK concepts, including:
3727

3828
- Starting and stopping tracking
3929
- Manually controlling motion state
4030
- Requesting the current location
4131
- Displaying basic tracking and event state
4232

43-
This app contains **no map view** and **no configuration UI**, making it ideal for
44-
first-time users.
33+
No map view, no configuration UI — ideal for first-time users.
34+
35+
---
36+
37+
## Which Should I Use?
38+
39+
- Start with **HelloWorld** if you want to understand the basics quickly.
40+
- Use **Advanced** if you want to explore the SDK's full capabilities and UI patterns.
41+
42+
---
43+
44+
## Demo Server
45+
46+
When the app launches it will ask you to register an **organization** and **username**. The example app posts your tracking data to Transistor Software's demo server at:
47+
48+
**[https://tracker.transistorsoft.com](https://tracker.transistorsoft.com)**
4549

46-
👉 See: [HelloWorld Demo App](./HelloWorld)
50+
View your results live on a map by navigating to:
51+
52+
```
53+
https://tracker.transistorsoft.com/<your-organization>
54+
```
55+
56+
> [!NOTE]
57+
> The demo server is for testing purposes only. Use any organization name — it acts as a namespace to group your devices.
58+
59+
![](https://raw.githubusercontent.com/transistorsoft/assets/master/images/tracker.transistorsoft.com.png)
4760

4861
---
4962

@@ -81,26 +94,10 @@ cd ios && pod install && cd ..
8194
npx react-native run-ios
8295
```
8396

84-
### Release builds
85-
86-
```bash
87-
npx react-native run-android --mode=release
88-
npx react-native run-ios --mode Release
89-
```
90-
91-
---
92-
93-
## Which Should I Use?
94-
95-
- Start with **HelloWorld** if you want to understand the basics quickly.
96-
- Use **Advanced** if you want to explore the SDK’s full capabilities and UI
97-
patterns.
98-
9997
---
10098

10199
## Learn More
102100

103-
- Documentation:
104-
https://transistorsoft.github.io/react-native-background-geolocation/latest/
105-
- GitHub repository:
106-
https://github.com/transistorsoft/react-native-background-geolocation
101+
- [Documentation](https://docs.transistorsoft.com/typescript/setup/)
102+
- [API Reference](https://docs.transistorsoft.com/typescript/BackgroundGeolocation/)
103+
- [GitHub repository](https://github.com/transistorsoft/react-native-background-geolocation)

0 commit comments

Comments
 (0)