Primer iOS SDK.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
NoPermissions/Primer.framework
Primer.framework
.cocoadocs.yml
CHANGELOG.md
README.md

README.md

Primer iOS SDK

CocoaPods Compatible Carthage Compatible Platform

Instantly deploy native screens without writing code. Primer enables you to design and test new user experiences, and personalize them for each user.

The Primer iOS SDK requires a free account to be created at https://goprimer.com, and your app to have a deployment target of at least iOS 8.

Get Started

  • We have a Quick Start Guide to help you get Primer up and running in your iOS app in less than 10 minutes.

  • If your app uses user accounts, follow up with our Quick Authentication Guide to get account authentication with Primer tied into your app's user system.

  • Upgrading from v2? We have an Upgrade Guide to cover you.

Installation

CocoaPods

To integrate using CocoaPods, add the necessary sources and the Primer pod to your Podfile:

pod 'Primer', '~> 3.6'
Carthage

To integrate using Carthage, add the following to your Cartfile:

github "goprimer/primer-ios-sdk" "~> 3.6"

Don't forget to add the path to the framework under "Input Files" for the copy-frameworks script Build Phase:

$(SRCROOT)/Carthage/Build/iOS/Primer.framework

Then add the AdSupport.framework in the Linked Frameworks and Libraries section of the General tab of your app target's settings.

Manually

To integrate manually please take a look at the Manual Integration section of our Quick Start Guide.

Integration

iOS 9 introduced App Transport Security that impacts your app and the Primer iOS SDK integration. To finish your integration you need to whitelist the Primer domains in your app by adding the following to your application's info plist.

<key>NSAppTransportSecurity</key>
<dict>
    <key>NSExceptionDomains</key>
    <dict>
        <key>goprimer.com</key>
        <dict>
            <key>NSIncludesSubdomains</key>
            <true/>
            <key>NSThirdPartyExceptionAllowsInsecureHTTPLoads</key>
            <true/>
        </dict>
    </dict>
</dict>

Usage

Start the SDK

First import Primer by adding #import <Primer/Primer.h> ( or import Primer for Swift) at the top of your application's delegate. Then in your -application:didFinishLaunchingWithOptions: implementation call our start method with your SDK token (you can find it in your Project Settings).

#import <Primer/Primer.h>

- (BOOL)application:(UIApplication *)application
didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    // Initialize the Primer SDK
    [Primer startWithToken:@"YOUR_APP_TOKEN"];
    return YES;
}
Present Onboarding

The most common time to present an onboarding experience is right when the application launches. The best way of doing this in most of the applications is by calling the presentation method in the -viewDidLoad of your first view controller to be presented to the user on app load.

To let the SDK automatically present an onboarding experience just simply call the +presentExperience method.

#import <Primer/Primer.h>
  
- (void)viewDidLoad {
    [super viewDidLoad];
    // Present the Primer onboarding experience
    [Primer presentExperience];
}

Contact Us

Need help or have questions? Please contact us at success@goprimer.com and we will provide you personal support to guarantee success in your app!