Skip to content

Commit eb6f66c

Browse files
committed
Updated README with instructions for installation using Cocoapods
1 parent 4bec97d commit eb6f66c

File tree

1 file changed

+17
-6
lines changed

1 file changed

+17
-6
lines changed

README.md

Lines changed: 17 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,16 @@ Please refer to the API documentation on the [Beaconstac developer hub](http://d
1212

1313
Try out the Beaconstac Demo app on the [iTunes App Store](https://itunes.apple.com/us/app/beaconstac/id956442796?mt=8).
1414

15-
## Integration with your existing project in XCode
15+
## Installation
16+
##### Using Cocoapods (recommended):
17+
Add the following to your Podfile in your project
18+
19+
pod 'Beaconstac'
20+
21+
Run `pod install` in the project directory
22+
23+
24+
##### Manually:
1625

1726
1. Download or clone this repo on your system.
1827
2. Drag and drop the Beaconstac.framework file into your Xcode project. Make sure that "Copy Items to Destination's Group Folder" is checked.
@@ -26,24 +35,26 @@ Try out the Beaconstac Demo app on the [iTunes App Store](https://itunes.apple.c
2635
- SystemConfiguration.framework
2736
- CoreBluetooth.framework
2837
- CoreLocation.framework
38+
39+
## Configure your project
2940

30-
5. In Info.plist, add a new field, NSLocationAlwaysUsageDescription with relevant value that you want to show to the user. This is mandatory for iOS 8 and above.
41+
1. In Info.plist, add a new field, NSLocationAlwaysUsageDescription with relevant value that you want to show to the user. This is mandatory for iOS 8 and above.
3142
<img src="images/usagedescription.png" alt="Build Phases" width="600">
3243

33-
6. Import the framework header in your class and make sure the class conforms to BeaconstacDelegate protocol
44+
2. Import the framework header in your class and make sure the class conforms to BeaconstacDelegate protocol
3445

3546
#import <Beaconstac/Beaconstac.h>
3647

37-
7. Initialize Beaconstac using the factory method:
48+
3. Initialize Beaconstac using the factory method:
3849

3950
beaconstacInstance = [Beaconstac sharedInstanceWithOrganizationId:<organizationId: Int> developerToken:<developerToken: String>];
4051
beaconstacInstance.delegate = self;
4152

42-
8. To start ranging beacons:
53+
4. To start ranging beacons:
4354

4455
[beaconstacInstance startRangingBeaconsWithUUIDString:@"F94DBB23-2266-7822-3782-57BEAC0952AC" beaconIdentifier:@"MobstacRegion" filterOptions:nil];
4556
46-
9. Implement delegate methods to receive callbacks when beacons are ranged:
57+
5. Implement delegate methods to receive callbacks when beacons are ranged:
4758

4859
- (void)beaconstac:(Beaconstac *)beaconstac rangedBeacons:(NSDictionary *)beaconsDictionary
4960
{

0 commit comments

Comments
 (0)