Skip to content

Commit

Permalink
Add a note about bluetooth usage description in the readme (#49)
Browse files Browse the repository at this point in the history
  • Loading branch information
zummenix authored and chwastek committed Oct 6, 2019
1 parent 8901207 commit 12558a8
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Other Proximity SDK highlights include:
- [Setting up tags](#setting-up-tags)
- [Inside your app](#inside-your-app)
- [(Optional) Adding attachments to your beacons](#optional-adding-attachments-to-your-beacons)
- [Location permissions and Background support](#location-permissions-and-background-support)
- [Location and Bluetooth permissions, Background support](#location-and-bluetooth-permissions-background-support)
- [Additional features](#additional-features)
- [Example apps](#example-apps)
- [Documentation](#documentation)
Expand Down Expand Up @@ -159,12 +159,16 @@ To configure the attachments:
<i>Assigning beacon attachments</i>
</p>

## Location permissions and Background support
## Location and Bluetooth permissions, Background support

Proximity SDK requires Location Services to work in the background, which means you need to ask users to allow the app to access their location. To do that, **set up the Location Services usage description**:

- Add a value for _Privacy - Location Always Usage Description_ key in your app's Info.plist file. This message will be shown to the user when the app calls `ProximityObserver.startObserving(...)`. It's ***required*** for Core Location to work.

Proximity SDK uses Bluetooth, which means you need to ask users to allow the app to access bluetooth. To do that, **set up Bluetooth usage description**:

- Add a value for _Privacy - Bluetooth Always Usage Description_ key in your app's Info.plist file.

To allow our app to run in the background when in range of beacons, **enable the Bluetooth Background Mode**:

- Set _Uses Bluetooth LE accessories_ in your Xcode project settings -> _Capabilities_ -> _Background Modes_. It's ***required*** for Core Bluetooth to work in the background.
Expand Down

0 comments on commit 12558a8

Please sign in to comment.