Skip to content

Commit a27fdec

Browse files
chore(docs): updating docs (#9)
1 parent d11ee30 commit a27fdec

File tree

8 files changed

+13
-5
lines changed

8 files changed

+13
-5
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616

1717
A React Native library for tracking location in the background using TurboModules (New Architecture). Track user location even when the app is minimized or in the background.
1818

19-
<video src="docs/assets/tracking.mp4" controls muted playsinline loop width="100%"></video>
19+
![Tracking demo](docs/assets/tracking.gif)
2020

2121
## Features
2222

docs/assets/background.gif

1.38 MB
Loading

docs/assets/background.mp4

-4.8 MB
Binary file not shown.

docs/assets/tracking.gif

1.29 MB
Loading

docs/assets/tracking.mp4

-1.38 MB
Binary file not shown.

docs/getting-started/INTEGRATION_GUIDE.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22

33
Step-by-step guide to integrate `@gabriel-sisjr/react-native-background-location` into your existing React Native app.
44

5+
![Background location tracking](../assets/background.gif)
6+
7+
*Background location tracking in action - tracking continues even when the app is minimized.*
8+
59
## Prerequisites
610

711
- React Native 0.70 or higher

docs/getting-started/QUICKSTART.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22

33
Get started with `@gabriel-sisjr/react-native-background-location` in 5 minutes.
44

5+
![Starting and stopping location tracking](../assets/tracking.gif)
6+
7+
*Example: Starting and stopping location tracking with the library.*
8+
59
## Installation
610

711
```bash

docs/getting-started/hooks.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -109,9 +109,9 @@ function PermissionHandler() {
109109

110110
Complete hook for managing background location tracking, including starting/stopping tracking and managing location data.
111111

112-
<video src="../assets/tracking.mp4" controls muted playsinline loop width="100%"></video>
112+
![Example app using useBackgroundLocation](../assets/tracking.gif)
113113

114-
<sub>Example app using `useBackgroundLocation` to start/stop a trip and refresh locations.</sub>
114+
*Example app using `useBackgroundLocation` to start/stop a trip and refresh locations.*
115115

116116
### Basic Usage
117117

@@ -371,9 +371,9 @@ function Footer() {
371371

372372
Hook for watching location updates in real-time. This hook automatically receives location updates as they are collected by the background service, without requiring manual refresh.
373373

374-
<video src="../assets/background.mp4" controls muted playsinline loop width="100%"></video>
374+
![Real-time updates using useLocationUpdates](../assets/background.gif)
375375

376-
<sub>Real‑time updates using `useLocationUpdates`, receiving new locations automatically.</sub>
376+
*Real‑time updates using `useLocationUpdates`, receiving new locations automatically.*
377377

378378
### Basic Usage
379379

0 commit comments

Comments
 (0)