Skip to content

Latest commit

 

History

History
89 lines (55 loc) · 4.7 KB

README.md

File metadata and controls

89 lines (55 loc) · 4.7 KB
Raw

Build Status Cocoapods Version Carthage compatible Apache License

Want to Contribute?

The Mixpanel library for iOS is an open source project, and we'd love to see your contributions! We'd also love for you to come and work with us! Check out http://boards.greenhouse.io/mixpanel/jobs/25226#.U_4JXEhORKU for details.

Painless Installation (CocoaPods)

Mixpanel supports Cocoapods for easy installation. To Install, see our full documentation »

Carthage

To install the carthage tool on your system, please download and run the Carthage.pkg file for the latest release, then follow the on-screen instructions.

Alternately, you can use Homebrew and install the carthage tool on your system simply by running brew update and brew install carthage.

Adding frameworks to an application

Once you have Carthage installed, you can begin adding frameworks to your project. Note that Carthage only supports dynamic frameworks, which are only available on iOS 8 or later.

If you're building for iOS

  1. Create a [Cartfile][] that lists the frameworks you’d like to use in your project.
  2. Run carthage update. This will fetch dependencies into a [Carthage/Checkouts][] folder, then build each one.
  3. On your application targets’ “General” settings tab, in the “Linked Frameworks and Libraries” section, drag and drop each framework you want to use from the [Carthage/Build][] folder on disk.
  4. On your application targets’ “Build Phases” settings tab, click the “+” icon and choose “New Run Script Phase”. Create a Run Script with the following contents:
/usr/local/bin/carthage copy-frameworks

and add the paths to the frameworks you want to use under “Input Files”, e.g.:

$(SRCROOT)/Carthage/Build/iOS/LlamaKit.framework
$(SRCROOT)/Carthage/Build/iOS/ReactiveCocoa.framework

This script works around an App Store submission bug triggered by universal binaries.

Manual Installation

To help users stay up to date with the latests version of our iOS SDK, we always recommend integrating our SDK via CocoaPods, which simplifies version updates and dependency management. However, there are cases where users can't use CocoaPods. Not to worry, just follow these manual installation steps and you'll be all set.

##Step 1: Clone the SDK

Git clone the latest version of "mixpanel-iphone" to your local machine using the following code in your terminal:

git clone https://github.com/mixpanel/mixpanel-iphone.git

If you don't have git installed, get it here.

##Step 2: Add the SDK to your app!

Add the "Mixpanel" folder from the "mixpanel-iphone" to your XCode project's folder:

alt text

And drag and drop the Mixpanel folder into your XCode Project Workspace:

alt text

##Step 3: Import All dependencies

Add all dependencies of the Mixpanel SDK to your app. The full list of necessary frameworks and libraries on lines 16-17 in the "Mixpanel.podspec" file in the "mixpanel-iphone" directory:

alt text

Step 4: Integrate!

Import "Mixpanel.h" into AppDelegate.m, and initialize Mixpanel within application:didFinishLaunchingWithOptions:

alt text

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    [Mixpanel sharedInstanceWithToken:MIXPANEL_TOKEN];
}

Start tracking

You're done! You've successfully integrated the Mixpanel SDK into your app. To stay up to speed on important SDK releases and updates, subscribe to the mp-dev Google group or watch the iPhone repository on Github.

Have any questions? Reach out to support@mixpanel.com to speak to someone smart, quickly.