Skip to content

Commit 5d07868

Browse files
committed
Updated README for 2.2.3
1 parent ddba480 commit 5d07868

File tree

1 file changed

+17
-17
lines changed

1 file changed

+17
-17
lines changed

README.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
## Requirements
2-
The Intercom iOS SDK supports iOS 7.x and iOS 8.x.
2+
Intercom for iOS supports iOS 7.x and iOS 8.x.
33

44
## Installation
55

@@ -19,18 +19,18 @@ Add the Intercom pod into your Podfile and run a `pod install` or `pod update`.
1919
4. Sometimes Xcode won't correctly add the `Intercom.bundle` so make sure to add it to your target's Copy Bundle Resources build phase. You will find the bundle in the `Intercom.framework/Versions/A/Resources` folder.
2020

2121

22-
If you get errors, check out our [Troubleshooting section here](http://docs.intercom.io/Install-on-your-mobile-product/install-the-intercom-ios-sdk#-troubleshooting-installation).
22+
If you get errors, check out our [Troubleshooting section here](http://docs.intercom.io/Install-on-your-mobile-product/installing-intercom-for-ios#troubleshooting-tips).
2323

2424

25-
##How should I use the Intercom SDK in my app?
26-
Broadly speaking, there are three types of apps that the Intercom SDK will work in.
25+
##How should I use Intercom for iOS in my app?
26+
Broadly speaking, there are three types of apps that Intercom for iOS will work in.
2727

2828
1. Apps that only have registered users, like Facebook, Instagram or Slack. Your users have to log in straight away in order to use your app. [Show me how.](https://github.com/intercom/intercom-ios#my-app-only-has-logged-in-users)
2929
2. Apps that never log users in, like Threes Game or Angry Birds or the iOS Notes app. Your users never have to log in to use your app. [Show me how.](https://github.com/intercom/intercom-ios#my-apps-users-never-log-in)
3030
3. Apps that support both logged in and logged out users, like Google Maps or Youtube. [Show me how.](https://github.com/intercom/intercom-ios#my-app-has-logged-in-and-logged-out-users)
3131

3232
### Initialize Intercom
33-
No matter what category of app you have, you'll need your Intercom app id and the iOS SDK API key that can be found on the [Intercom App Settings](https://app.intercom.io/) page in the API keys section. Once you've found those keys, initialize Intercom by calling the following in your application delegate:
33+
No matter what category of app you have, you'll need your Intercom app id and the iOS API key that can be found on the [Intercom App Settings](https://app.intercom.io/) page in the API keys section. Once you've found those keys, initialize Intercom by calling the following in your application delegate:
3434

3535
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
3636
// Initialize Intercom
@@ -60,11 +60,11 @@ No matter what category of app you have, you'll need your Intercom app id and th
6060
}
6161
}
6262
63-
3. Finally, when users eventually want to log out of your app, we should clear the Intercom SDK's caches so that when they log back in again, everything works perfectly. In your logout code, simply call `[Intercom reset];` like so:
63+
3. Finally, when users eventually want to log out of your app, we should clear Intercom for iOS's caches so that when they log back in again, everything works perfectly. In your logout code, simply call `[Intercom reset];` like so:
6464

6565
- (void)logout {
6666
...
67-
// This reset's the Intercom SDK's cache of your user's identity and wipes the slate clean.
67+
// This reset's the Intercom integration's cache of your user's identity and wipes the slate clean.
6868
[Intercom reset];
6969
}
7070

@@ -106,11 +106,11 @@ Because Intercom listens for UIApplication start notifications, there is no need
106106
}
107107
}
108108
109-
3. Finally, when users eventually want to log out of your app, we should clear the Intercom SDK's caches so that when they log back in again, everything works perfectly. In your logout code, simply call `[Intercom reset];` like so:
109+
3. Finally, when users eventually want to log out of your app, we should clear Intercom for iOS's caches so that when they log back in again, everything works perfectly. In your logout code, simply call `[Intercom reset];` like so:
110110

111111
- (void)logout {
112112
...
113-
// This reset's the Intercom SDK's cache of your user's identity and wipes the slate clean.
113+
// This reset's the Intercom integration's cache of your user's identity and wipes the slate clean.
114114
[Intercom reset];
115115
116116
// Now that you have logged your user out and reset, you can register a new
@@ -119,26 +119,26 @@ Because Intercom listens for UIApplication start notifications, there is no need
119119
}
120120

121121

122-
###Tips on getting the best out of the SDK
122+
###Tips on getting the best out of the Intercom for iOS
123123

124124
1. **Do not use an email address as a `userId` as this field is unique and cannot be changed or updated later.** If you only have an `email` address, you can just register a user with that. [More details are available here](https://github.com/intercom/intercom-ios/blob/master/Intercom.framework/Versions/A/Headers/Intercom.h#L168).
125-
2. The Intercom SDK listens for when your app starts and stops, so all you need to do is register a type of user like the examples above and we'll do the rest.
125+
2. Intercom for iOS listens for when your app starts and stops, so all you need to do is register a type of user like the examples above and we'll do the rest.
126126

127127

128128
## How does the in-app messenger work?
129129

130-
Intercom allows you to send messages to your users while also enabling your users send messages to you. If you have a dedicated button in your app that you wish to hook the new message composer up to, you can control Intercom's messaging UI via the `[Intercom presentMessageComposer];` and `[Intercom presentConversationList];` methods. More information on messaging with the iOS SDK can be found [here](http://docs.intercom.io/configure-ios-sdk#messaging).
130+
Intercom allows you to send messages to your users while also enabling your users send messages to you. If you have a dedicated button in your app that you wish to hook the new message composer up to, you can control Intercom's messaging UI via the `[Intercom presentMessageComposer];` and `[Intercom presentConversationList];` methods. More information on messaging with Intercom for iOS can be found [here](http://docs.intercom.io/Install-on-your-mobile-product/configuring-intercom-for-ios#messaging).
131131

132132
## What about events, push notifications, company and user data?
133133

134-
The iOS SDK has support for all these things. For full details please read our [documentation](http://docs.intercom.io/configure-ios-sdk).
134+
Intercom for iOS has support for all these things. For full details please read our [documentation](http://docs.intercom.io/Install-on-your-mobile-product/configuring-intercom-for-ios).
135135

136136

137-
## I'm using a previous version of the SDK and this looks different, what's changed?
137+
## I'm using a previous version and this looks different, what's changed?
138138

139-
We have re-architected the iOS SDK to ensure it is as reliable as possible while tracking your users. We have focused on removing the asychronous behaviour of the SDK, for example you no longer need to wait for the completion blocks of the now deprecated `beginSession` calls before logging events or updating user data. In doing so the SDK is more nimble and reliable than ever before.
139+
We have re-architected Intercom for iOS to ensure it is as reliable as possible while tracking your users. We have focused on removing the asychronous behaviour of Intercom for iOS, for example you no longer need to wait for the completion blocks of the now deprecated `beginSession` calls before logging events or updating user data. In doing so it is more nimble and reliable than ever before.
140140

141-
Previous versions of the SDK will migrate with minimal effort. All deprecated methods still work for now, excluding the old session listener (since v2.0.6). These deprecated methods will be permanently removed in a future version.
141+
Previous versions of Intercom for iOS will migrate with minimal effort. All deprecated methods still work for now, excluding the old session listener (since v2.0.6). These deprecated methods will be permanently removed in a future version.
142142

143143
## Documentation and getting started guides
144144

@@ -156,4 +156,4 @@ are available in [our documentation](http://docs.intercom.io/Install-on-your-mob
156156

157157
## Xcode Documentation
158158

159-
This documentation provides integrated help in Xcode for all public APIs in the Intercom SDK. [Download the docset](https://github.com/intercom/intercom-ios/archive/master.zip) from the repository above and Copy the content into ~`/Library/Developer/Shared/Documentation/DocSets`.
159+
This documentation provides integrated help in Xcode for all public APIs in Intercom for iOS. [Download the docset](https://github.com/intercom/intercom-ios/archive/master.zip) from the repository above and Copy the content into ~`/Library/Developer/Shared/Documentation/DocSets`.

0 commit comments

Comments
 (0)