|
1 |
| -<img src="images/Iterable-Logo.svg"> |
| 1 | + |
2 | 2 |
|
3 | 3 | [](https://opensource.org/licenses/MIT)
|
4 | 4 | [](https://travis-ci.com/Iterable/swift-sdk)
|
5 | 5 | [](https://cocoapods.org/pods/Iterable-iOS-SDK)
|
6 | 6 | [](https://github.com/Carthage/Carthage)
|
7 | 7 |
|
8 |
| -# Iterable iOS SDK |
| 8 | +# Iterable's iOS SDK |
9 | 9 |
|
10 |
| -Iterable is a complete cross-channel customer engagement platform. Use it to message your customers across various channels (email, SMS, push, in-app messages, and web push notification) and grow your customer base, their engagement, and their lifetime value. |
| 10 | +[Iterable](https://www.iterable.com) is a growth marketing platform that helps |
| 11 | +you to create better experiences for—and deeper relationships with—your |
| 12 | +customers. Use it to send customized email, SMS, push notification, in-app |
| 13 | +message, and web push notifications to your customers. |
11 | 14 |
|
12 |
| -Iterable lets you send the right message, to the right device, at the right time. |
| 15 | +This SDK helps you integrate your iOS apps with Iterable. It supports iOS 9.0+. |
13 | 16 |
|
14 |
| -- [Iterable User Handbook](https://support.iterable.com/hc/articles/217389766) |
15 |
| -- [Mobile Engineer Guide](https://support.iterable.com/hc/articles/115000300426) |
| 17 | +## Installation |
| 18 | + |
| 19 | +For installation instructions, read [Iterable's iOS SDK](https://support.iterable.com/hc/articles/360035018152). |
16 | 20 |
|
17 | 21 | ## Features
|
18 | 22 |
|
19 |
| -- [SDK Initialization](https://support.iterable.com/hc/articles/360035018152) |
20 |
| -- [User Identity](https://support.iterable.com/hc/articles/360035402531) |
| 23 | +To learn more about various SDK features, read: |
| 24 | + |
| 25 | +- [Identifying the User](https://support.iterable.com/hc/articles/360035402531) |
| 26 | +- [Updating User Profiles](https://support.iterable.com/hc/articles/360035402611) |
21 | 27 | - [Tracking Events](https://support.iterable.com/hc/articles/360035395671)
|
22 |
| -- [Push Notifications](https://support.iterable.com/hc/articles/115000315806) |
23 |
| -- [Deep Linking](https://support.iterable.com/hc/articles/360035453971) |
24 |
| -- [Universal Links](https://support.iterable.com/hc/articles/360035496511) |
25 |
| -- [In-App Messages](https://support.iterable.com/hc/articles/360035536791) |
26 |
| -- [Mobile Inbox](https://support.iterable.com/hc/articles/360039137271) |
| 28 | +- [Setting up iOS Push Notifications](https://support.iterable.com/hc/articles/115000315806) |
| 29 | +- [Advanced iOS Push Notifications](https://support.iterable.com/hc/articles/360035451931) |
| 30 | +- [In-App Messages on iOS](https://support.iterable.com/hc/articles/360035536791) |
| 31 | +- [Setting up Mobile Inbox on iOS](https://support.iterable.com/hc/articles/360039137271) |
| 32 | +- [Customizing Mobile Inbox on iOS](https://support.iterable.com/hc/articles/360039091471) |
| 33 | +- [iOS Universal Links](https://support.iterable.com/hc/articles/360035496511) |
| 34 | +- [Deep Links in Push Notifications](https://support.iterable.com/hc/articles/360035453971) |
| 35 | +- [Deferred Deep Linking](https://support.iterable.com/hc/articles/360035165872) |
| 36 | + |
| 37 | +## Sample projects |
27 | 38 |
|
28 |
| -## Sample Projects |
| 39 | +For sample code, take a look at the following projects: |
29 | 40 |
|
30 |
| -- [Swift sample project](https://github.com/Iterable/swift-sdk/blob/master/sample-apps/swift-sample-app) |
31 |
| -- [Objective-C sample project](https://github.com/Iterable/swift-sdk/blob/master/sample-apps/objc-sample-app) |
| 41 | +- [Swift](https://github.com/Iterable/swift-sdk/blob/master/sample-apps/swift-sample-app) |
| 42 | +- [Objective-C](https://github.com/Iterable/swift-sdk/blob/master/sample-apps/objc-sample-app) |
32 | 43 | - [Inbox Customization](https://github.com/Iterable/swift-sdk/tree/master/sample-apps/inbox-customization)
|
33 | 44 |
|
34 |
| -## Version Support |
| 45 | +## Release notes, support, and troubleshooting |
35 | 46 |
|
36 |
| -- The Iterable iOS SDK supports iOS 9.0 and higher. |
37 |
| -- [iOS SDK Release Notes](https://support.iterable.com/hc/en-us/articles/360027798391) |
38 |
| -- [Mobile SDK Support Policy](https://support.iterable.com/hc/articles/360027798391#mobile-sdk-support-policy) |
| 47 | +For release notes, read: |
39 | 48 |
|
40 |
| -## Questions? |
| 49 | +- [iOS SDK Release Notes](https://support.iterable.com/hc/articles/360027798391) (major releases) |
| 50 | +- [Releases page](https://github.com/Iterable/swift-sdk/releases) on GitHub (minor releases) |
41 | 51 |
|
42 |
| -- [Mobile Developer Guides](https://support.iterable.com/hc/categories/360002288712) |
43 |
| -- [Mobile Support FAQ](https://support.iterable.com/hc/articles/360035624191) |
44 |
| -- [Mobile SDK Troubleshooting](https://support.iterable.com/hc/articles/360035392251) |
| 52 | +For information about Iterable's iOS SDK support policies, take a look at: |
45 | 53 |
|
46 |
| -## License |
| 54 | +- Iterable's [Mobile SDK Support Policy](https://support.iterable.com/hc/articles/360027798391#mobile-sdk-support-policy) |
| 55 | +- Iterable's [iOS SDK Deprecation and End-of-Life Schedule](https://support.iterable.com/hc/articles/360027798391#ios-sdk-deprecation-and-end-of-life-schedule) |
47 | 56 |
|
48 |
| -The MIT License |
| 57 | +For troubleshooting help, read: |
49 | 58 |
|
50 |
| -See [LICENSE](https://github.com/Iterable/swift-sdk/blob/master/LICENSE?raw=true) |
| 59 | +- [Testing and Troubleshooting Iterable's Mobile SDKs](https://support.iterable.com/hc/articles/360035392251) |
| 60 | +- [Frequently Asked Questions](https://support.iterable.com/hc/articles/360035624191) |
| 61 | + for mobile developers integrating with Iterable |
51 | 62 |
|
52 |
| -## Want to contribute? |
| 63 | +Please contact your customer success manager with any questions. |
53 | 64 |
|
54 |
| -This library is open source, and we will look at issue reports and pull requests! |
| 65 | +## License |
| 66 | + |
| 67 | +This SDK is released under the MIT License. See [LICENSE](https://github.com/Iterable/swift-sdk/blob/master/LICENSE?raw=true) |
| 68 | +for more information. |
| 69 | + |
| 70 | +## Want to contribute? |
55 | 71 |
|
| 72 | +This library is open source, and we will look at issue reports and pull requests. |
56 | 73 | See [CONTRIBUTING](CONTRIBUTING.md) for more information.
|
0 commit comments