Skip to content

Commit a2dd2e1

Browse files
Add note about iOS background usage description to README
1 parent 77ebe80 commit a2dd2e1

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,17 @@ Apple requires privacy descriptions to be specified in `Info.plist` for location
1616
- `NSLocationAlwaysAndWhenInUseUsageDescription` (`Privacy - Location Always and When In Use Usage Description`)
1717
- `NSLocationWhenInUseUsageDescription` (`Privacy - Location When In Use Usage Description`)
1818

19+
> [!NOTE]
20+
> This Capacitor plugin does not support background geolocation directly. However, it relies on
21+
> [`ion-ios-geolocation`](https://github.com/ionic-team/ion-ios-geolocation), which can report
22+
> location in the background. As a result, Apple requires you to include a
23+
> `NSLocationAlwaysAndWhenInUseUsageDescription` entry in your `Info.plist`. Since this permission
24+
> prompt won’t appear to users, you can safely use the same description string as for
25+
> `NSLocationWhenInUseUsageDescription`.
26+
1927
Read about [Configuring `Info.plist`](https://capacitorjs.com/docs/ios/configuration#configuring-infoplist) in the [iOS Guide](https://capacitorjs.com/docs/ios) for more information on setting iOS permissions in Xcode
2028

29+
2130
## Android
2231

2332
This plugin requires the following permissions be added to your `AndroidManifest.xml`:

0 commit comments

Comments
 (0)