<commit_before>Keen IO iOS SDK
===============

[![Build Status](https://travis-ci.org/keenlabs/KeenClient-iOS.png)](https://travis-ci.org/keenlabs/KeenClient-iOS)

The Keen IO iOS client is designed to be simple to develop with, yet incredibly flexible. Our goal is to let you decide what events are important to you, use your own vocabulary to describe them, and decide when you want to send them to Keen IO.

While the name of this repo implies that this SDK is strictly for iOS, it can also be used in Mac OS applications by using the Cocoa version as outlined below. The code base is the same, but the build targets are different. :)

* [Installation](#installation) - How to install `KeenClient` in your application
* [Usage](#usage) - How to use `KeenClient`
	* [Add Events](#add-events) - How to add an event
	* [Global Properties](#global-properties) - How to set global properties
	* [Geo Location](#geo-location) - How to use Geo Location
	* [Upload to Keen](#upload-events-to-keen-io) - How to upload all previously saved events
	* [Add-ons](#add-ons) - How to use Keen's [Data Enrichment](https://keen.io/docs/data-collection/data-enrichment/#data-enrichment) features to enrich your data
	* [Debugging](#debugging) - How to debug your application using the SDK's built in logging
* [FAQs](#faqs)
* [Changelog](#changelog)
* [To Do](#to-do)
* [Questions & Support](#questions--support)
* [Contributing](#contributing)
* [API Documentation](https://keen.io/static/iOS-reference/index.html)

### Installation

Installing the client should be a breeze. If it's not, please let us know at [<EMAIL>](mailto:<EMAIL>)!

#### Universal Binary

Our recommended way of installing `KeenClient` is to use the universal binary we’ve created. We have binaries for both [Cocoa](http://keen.io/static/code/KeenClient-Cocoa.zip) and [iOS](http://keen.io/static/code/KeenClient.zip).

> While we think the universal binary makes things really easy, we love to be transparent. We love feedback, especially in the form of pull requests. :)

##### Download

* [Cocoa](http://keen.io/static/code/KeenClient-Cocoa.zip)
* [iOS](http://keen.io/static/code/KeenClient.zip)

##### Uncompress - Cocoa

Uncompress the archive. It should contain a folder called “KeenClient-Cocoa” with the following contents:

* libKeenClient-Cocoa.a
* KeenClient.h
* KeenProperties.h
* KIOEventStore.h

##### Add Files to XCode - Cocoa

Drag the "KeenClient-Cocoa" folder into your XCode project.

##### Uncompress - iOS

Uncompress the archive. It should contain a folder called “KeenClient” with the following contents:

* libKeenClient-Aggregate.a
* KeenClient.h
* KeenProperties.h
* KIOEventStore.h

##### Add Files to XCode - iOS

Drag the "KeenClient" folder into your XCode project.

#### CocoaPods - iOS

If you're using [CocoaPods](http://cocoapods.org/), add the following to your Podfile:

```<commit_msg>Removed iOS label from CocoaPods, because CocoaPods is universal<commit_after>Keen IO iOS SDK
===============

[![Build Status](https://travis-ci.org/keenlabs/KeenClient-iOS.png)](https://travis-ci.org/keenlabs/KeenClient-iOS)

The Keen IO iOS client is designed to be simple to develop with, yet incredibly flexible. Our goal is to let you decide what events are important to you, use your own vocabulary to describe them, and decide when you want to send them to Keen IO.

While the name of this repo implies that this SDK is strictly for iOS, it can also be used in Mac OS applications by using the Cocoa version as outlined below. The code base is the same, but the build targets are different. :)

* [Installation](#installation) - How to install `KeenClient` in your application
* [Usage](#usage) - How to use `KeenClient`
	* [Add Events](#add-events) - How to add an event
	* [Global Properties](#global-properties) - How to set global properties
	* [Geo Location](#geo-location) - How to use Geo Location
	* [Upload to Keen](#upload-events-to-keen-io) - How to upload all previously saved events
	* [Add-ons](#add-ons) - How to use Keen's [Data Enrichment](https://keen.io/docs/data-collection/data-enrichment/#data-enrichment) features to enrich your data
	* [Debugging](#debugging) - How to debug your application using the SDK's built in logging
* [FAQs](#faqs)
* [Changelog](#changelog)
* [To Do](#to-do)
* [Questions & Support](#questions--support)
* [Contributing](#contributing)
* [API Documentation](https://keen.io/static/iOS-reference/index.html)

### Installation

Installing the client should be a breeze. If it's not, please let us know at [<EMAIL>](mailto:<EMAIL>)!

#### Universal Binary

Our recommended way of installing `KeenClient` is to use the universal binary we’ve created. We have binaries for both [Cocoa](http://keen.io/static/code/KeenClient-Cocoa.zip) and [iOS](http://keen.io/static/code/KeenClient.zip).

> While we think the universal binary makes things really easy, we love to be transparent. We love feedback, especially in the form of pull requests. :)

##### Download

* [Cocoa](http://keen.io/static/code/KeenClient-Cocoa.zip)
* [iOS](http://keen.io/static/code/KeenClient.zip)

##### Uncompress - Cocoa

Uncompress the archive. It should contain a folder called “KeenClient-Cocoa” with the following contents:

* libKeenClient-Cocoa.a
* KeenClient.h
* KeenProperties.h
* KIOEventStore.h

##### Add Files to XCode - Cocoa

Drag the "KeenClient-Cocoa" folder into your XCode project.

##### Uncompress - iOS

Uncompress the archive. It should contain a folder called “KeenClient” with the following contents:

* libKeenClient-Aggregate.a
* KeenClient.h
* KeenProperties.h
* KIOEventStore.h

##### Add Files to XCode - iOS

Drag the "KeenClient" folder into your XCode project.

#### CocoaPods

If you're using [CocoaPods](http://cocoapods.org/), add the following to your Podfile:

```
{'fraction_non_alphanumeric': 0.12282814381558575, 'fraction_numerical': 0.0, 'mean_word_length': 4.5903846153846155, 'pattern_counts': {'":': 0, '<': 7, '<?xml version=': 0, '>': 9, 'https://': 8, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '4950030', 'n_tokens_mistral': 1881, 'n_tokens_neox': 1790, 'n_words': 647}