Skip to content

Commit ee82479

Browse files
committed
Improvements to readme from @msaffitz
1 parent 5cb6a11 commit ee82479

File tree

1 file changed

+16
-17
lines changed

1 file changed

+16
-17
lines changed

README.md

+16-17
Original file line numberDiff line numberDiff line change
@@ -22,11 +22,11 @@ You can clone our iOS SDK using git: `git clone https://github.com:apptentive/ap
2222

2323
#### Using CocoaPods
2424

25-
Please note that if you use CocoaPods to get Apptentive, you can skip workspace configuration and go directly to Apptentive implementation below.
25+
Please note that if you use CocoaPods to integrate Apptentive, you can skip the "Setup Xcode Project" section and proceed directly to the ["Implement Apptentive in Project"](https://github.com/apptentive/apptentive-ios#implement-apptentive-in-project) directions below.
2626

2727
##### Create Podfile
2828

29-
1. Search for Apptentive's pod information on [CocoaPods](https://cocoapods.org).
29+
1. Find [Apptentive's pod information](http://cocoapods.org/?q=apptentive-ios) on [CocoaPods](http://cocoapods.org).
3030
2. List and save the dependencies in a text file named "Podfile" in your Xcode project directory. It should look something like this:
3131

3232
```
@@ -143,7 +143,7 @@ file navigator into `Copy Bundle Resources`.
143143

144144
### Implement Apptentive in Project
145145

146-
#### Message Center
146+
#### Set Apptentive API key
147147

148148
`ApptentiveConnect` queues feedback and attempts to upload in the background. This
149149
is intended to provide as quick a mechanism for submitting feedback as possible.
@@ -154,14 +154,14 @@ startup.
154154

155155
1. Open up your app's `AppDelegate.m` file.
156156
2. Under `#import "AppDelegate.h"`, import the `ATConnect.h` file.
157-
3. Under implementation, edit the `application:didFinishLaunchingWithOptions:` method to look like so:
157+
3. Under implementation, set your Apptentive API key in the `application:didFinishLaunchingWithOptions:` method:
158158

159159
``` objective-c
160160
#include "ATConnect.h"
161161
// ...
162-
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions
163-
ATConnect *connection = [ATConnect sharedConnection];
164-
connection.apiKey = @"Your_Apptentive_API_Key";
162+
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
163+
// ...
164+
[ATConnect sharedConnection].apiKey = @"Your_Apptentive_API_Key";
165165
// ...
166166
}
167167
```
@@ -172,12 +172,13 @@ As soon as you set the API key on the shared connection object, any queued feedb
172172
will start to upload, pending network availability. You also should not have
173173
to set the API key again on the shared connection object.
174174

175-
------------------------------------------------------------------------------------
175+
#### Message Center
176+
177+
The Apptentive Message Center provides an interface for you to communicate directly with your customers. People using your app are able to send you messages, which are routed to your Apptentive dashboard. When you reply to customer feedback, your response will immediately show up in the Message Center in their app.
176178

177-
Now, wherever you want to launch the Apptentive feedback UI:
179+
You might have a menu item in your settings menu, for example, titled "Feedback". When the user clicks on this item, you will open the Message Center. People might also be routed to Message Center through other interactions, such as the rating prompt.
178180

179-
1. Include the `ATConnect.h` header file.
180-
2. Add the following code to whichever method responds to feedback.
181+
When you want to launch the Apptentive Message Center and feedback UI, import `ATConnect.h` then call `presentMessageCenterFromViewController:`:
181182

182183
``` objective-c
183184
#include "ATConnect.h"
@@ -236,7 +237,7 @@ You'll want to add calls to `engage:fromViewController:` wherever it makes sense
236237
237238
#### Seed your App with Events
238239
239-
You should *seed* your app with certain Apptentive events at important events in your app. An event for when the app finishes launching. An event when your customer makes a purchase. An event for all the important steps in your app's lifecycle.
240+
You should *seed* your app with certain Apptentive events at important points in your app. An event for when the app finishes launching. An event when your customer makes a purchase. An event for all the important steps in your app's lifecycle.
240241
241242
Common app events that we recommend logging include:
242243
@@ -258,7 +259,7 @@ An Apptentive **interaction** is a specific piece of your app that can be shown
258259
259260
#### Interactions are Configurable via the Apptentive Website
260261
261-
The real strengths of Apptentive Events and Interactions come from their remote configurability.
262+
The real strength of Apptentive Events and Interactions come from their remote configurability.
262263
263264
Prior to releasing your app on the App Store, seed your app with certain events.
264265
@@ -284,7 +285,7 @@ Thus, the only code needed to display a Rating Prompt is to engage events using
284285
[[ATConnect sharedConnection] engage:@"completed_level" fromViewController:viewController];
285286
```
286287

287-
One you have engaged some events, you can create a rating prompt and modify the parameters which determine when it will be shown in your interaction settings on [Apptentive](https://apptentive.com).
288+
One you have engaged some events, you can create a rating prompt and modify the parameters which determine when it will be shown in your interaction settings on [Apptentive](http://www.apptentive.com).
288289

289290
### Upgrade Messages
290291

@@ -410,9 +411,7 @@ If the push notification was sent by Apptentive, we will then present Message Ce
410411

411412
#### Metrics
412413

413-
Metrics provide insight into exactly where people begin and end interactions
414-
with your app and with feedback, ratings, and surveys. You can enable and disable
415-
metrics on your app settings page on [Apptentive](https://apptentive.com).
414+
Metrics provide insight into how people are engaging with your app, and exactly which Apptentive events and interactions are being used.
416415

417416
#### Sample Application
418417

0 commit comments

Comments
 (0)