Merge pull request #3 from SoundwaveApp/1.1.1

1.1.1

Author: ClodaghML

CHANGELOG.md

@@ -3,6 +3,15 @@ All notable changes to this project will be documented in this file.
 `Shine-iOS` adheres to [Semantic Versioning](http://semver.org/).
 
 ---
+
+## [1.1.1](https://github.com/SoundwaveApp/Shine-iOS/releases/tag/1.1.1) (2015-07-31)
+
+#### Updated
+
+* Clarifications in contacts and location sync instructions
+* Improved debug logging
+
+
 ## [1.1](https://github.com/SoundwaveApp/Shine-iOS/releases/tag/1.1) (2015-07-28)
 
 #### What's New

README.md

@@ -91,6 +91,9 @@ The following Shine integration points are not mandatory when using Shine.
 Shine can capture a device's location if the host app has the required location services permissions.
 To capture location data, you need to add the following code to a class that conforms to the CLLocationDelegate protocol.
 ```objective-c
+#import <Shine/Shine.h>
+
+...
 
 - (void)locationManager:(CLLocationManager *)manager didUpdateLocations:(NSArray *)locations {
     [Shine updateLocation:locations];
@@ -102,8 +105,11 @@ An example of capturing location data is available in the example app.
 
 ###Contacts Syncing###
 
-Shine can capture a device's contacts if the host app has the required contacts access permissions.
+Shine can capture a device's contacts if the host app has the required contacts access permissions. Make a call to `[Shine syncContacts]` after permission to access contacts has been granted.
+
 ```objective-c
+#import <Shine/Shine.h>
+
 ABAddressBookRequestAccessWithCompletion(ABAddressBookCreateWithOptions(nil, nil), ^(bool granted, CFErrorRef error) {
        if (granted) {
            [Shine syncContacts];

Shine.framework/Headers

@@ -0,0 +1,22 @@
+//
+//  SWUser.h
+//  Shine
+//
+//  Created by Brian Boyle on 16/06/2015.
+//  Copyright (c) 2015 Liam Russell. All rights reserved.
+//
+
+#import <Foundation/Foundation.h>
+
+@interface SWUser : NSObject
+
+@property (nonatomic, copy) NSString *firstName;
+@property (nonatomic, copy) NSString *middleName;
+@property (nonatomic, copy) NSString *lastName;
+@property (nonatomic, copy) NSString *email;
+@property (nonatomic, copy) NSString *zip;
+@property (nonatomic, copy) NSString *yearOfBirth;
+@property (nonatomic, copy) NSString *dateOfBirth;
+@property (nonatomic, copy) NSString *gender;
+
+@end

Shine.framework/Headers/SWUser.h

@@ -0,0 +1,41 @@
+//
+//  Shine.h
+//  Shine
+//  Created by Brian Boyle on 08/06/2015.
+//  Copyright (c) 2015 Soundwave. All rights reserved.
+
+
+@import UIKit;
+@import Foundation;
+@import CoreLocation;
+
+
+//! Project version number for Shine.
+FOUNDATION_EXPORT double ShineVersionNumber;
+
+//! Project version string for Shine.
+FOUNDATION_EXPORT const unsigned char ShineVersionString[];
+
+// In this header, you should import all the public headers of your framework using statements like #import <Shine/PublicHeader.h>
+#import <Shine/SWUser.h>
+
+@interface Shine : NSObject
+
+
+#pragma mark - Startup
+
++ (void)setDeveloperKey:(NSString *)token;
++ (void)registerUserDetails:(SWUser *)userDetails;
+
+#pragma mark - Permissions
+
++ (void)syncContacts;
++ (void)updateLocation:(NSArray *)locations;
+
+
+#pragma mark - Debug
+
++ (void)enableLogging;
++ (void)enableVerboseLogging;
+
+@end

Shine.framework/Headers/Shine.h

@@ -0,0 +1,6 @@
+framework module Shine {
+  umbrella header "Shine.h"
+
+  export *
+  module * { export * }
+}