Permalink
Browse files

Updated README

  • Loading branch information...
1 parent 049e497 commit ffa3371884f5327e01f611ab0ea4c227f9a7c438 @sherpachick sherpachick committed Jan 30, 2012
Showing with 8 additions and 8 deletions.
  1. +8 −8 README.md
View
@@ -8,6 +8,10 @@ regardless of which analytics provider you're using behind the scenes.
The benefit of using AnalyticsKit is that if you decide to start using a new
analytics provider, or add an additional one, you need to write/change much less code!
+If you have additions or enhancements please submit pull requests.
+
+AnalyticsKit works both in ARC based projects and non-ARC projects.
+
INCLUDED PROVIDERS
==================
@@ -21,10 +25,11 @@ USAGE
=====
1. Download the provider's SDK and add it to your project
-2. In your AppDelegate's applicationDidFinishLaunchingWithOptions (or in a method called from there), create an AnalyticsKit*Provider (where * is the provider); add it to your loggers array; and call initializeLoggers
+2. Add AnalyticsKit to your project either as a git-submodule or copying the source into your project. In Xcode only include AnalyticsKit.m and AnalyticsKit.h and any providers you plan to use
+
+3. In your AppDelegate's applicationDidFinishLaunchingWithOptions (or in a method called from there), create an AnalyticsKit*Provider (where * is the provider); add it to your loggers array; and call initializeLoggers
```obj-c
-/******* SAMPLE CODE
// Create the AnalyticsKitApsalarProvider
NSString *apsalarKey = @"myAPIKey";
NSString *apsalarSecret = @"mySecret";
@@ -42,8 +47,6 @@ USAGE
//initialize AnalyticsKit to send messages to Flurry and TestFlight
[AnalyticsKit initializeLoggers:loggers];
-
-**************/
```
3. Where significant events occur, call AnalyticsKit logEvent: or other appropriate method. Example:
@@ -54,7 +57,4 @@ USAGE
4. You may also want to make AnalyticsKit calls at application lifecycle events, such as applicationDidEnterBackground, applicationWillTerminate, applicationWillEnterForeground
-----> SEE ANALYTICSKIT.H for an overview of the methods available. Doublecheck that the methods you call are implemented in the AnalyticsKit*Provider.m that you are using!
-
-
-
+See AnalyticsKit.h for an overview of the methods available. Doublecheck that the methods you call are implemented in the AnalyticsKit*Provider.m that you are using!

0 comments on commit ffa3371

Please sign in to comment.