Skip to content

Commit 80991a9

Browse files
committed
Update README
1 parent d13aaf0 commit 80991a9

File tree

1 file changed

+9
-5
lines changed

1 file changed

+9
-5
lines changed

README.md

+9-5
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ Run `pod install` in the project directory
3535

3636
## Configure your project
3737

38-
1. In Info.plist, add a new fields, `NSLocationAlwaysUsageDescription`, `NSLocationAlwaysAndWhenInUsageDescription`, `NSBluetoothPeripheralUsageDescription` with relevant values that you want to show to the user. This is mandatory for iOS 10 and above.
38+
1. In Info.plist, add a new fields, `NSLocationAlwaysUsageDescription`, `NSLocationAlwaysAndWhenInUseUsageDescription`, `NSLocationWhenInUseUsageDescription`, `NSBluetoothPeripheralUsageDescription`, `NSBluetoothAlwaysUsageDescription` with relevant values that you want to show to the user. This is mandatory for iOS 10 and above.
3939

4040
2. Enable `Uses Bluetooth LE accessories` in the Background Modes under Capabilities section.
4141

@@ -162,6 +162,10 @@ nearbee.enableBackgroundNotification(true)
162162
```
163163
164164
7. Overriding notification sound name
165+
166+
Please enable the notification sound by setting UserDefaults.standard.setValue(true, forKey: "NearBeeToggleSound")
167+
168+
165169
```swift
166170
if let alertSound = YOUR_URL {
167171
let soundName = UNNotificationSoundName(rawValue: alertSound.lastPathComponent)
@@ -220,7 +224,7 @@ let nearbee = NearBee.initNearBee()
220224

221225
nearbee.delegate = self // If any error occurred in nearbee
222226

223-
nearbee.startGeofenceMonitoring { result in
227+
nearbee.startMonitoringGeoFenceRegions { result in
224228
}
225229
```
226230

@@ -229,7 +233,7 @@ NearBee *nearbee = [NearBee initNearBee];
229233

230234
nearbee.delegate = self; // If any error occurred in nearbee
231235

232-
[nearbee startGeofenceMonitoring:^(BOOL result) {
236+
[nearbee startMonitoringGeoFenceRegions:^(BOOL result) {
233237

234238
}];
235239
```
@@ -240,15 +244,15 @@ let nearbee = NearBee.initNearBee()
240244
241245
nearbee.delegate = self
242246
243-
nearbee.stopGeoFenceMonitoring()
247+
nearbee.stopMonitoringGeoFenceRegions()
244248
```
245249

246250
```objective-c
247251
NearBee *nearbee = [NearBee initNearBee];
248252

249253
nearbee.delegate = self;
250254

251-
[nearbee stopGeoFenceMonitoring];
255+
[nearbee stopMonitoringGeoFenceRegions];
252256
```
253257

254258
### Geofence Notification threshold

0 commit comments

Comments
 (0)