Skip to content

Commit 5b60a86

Browse files
authored
Merge pull request #227 from Iterable/MOB-1415-layout
[MOB-1415] new layout of readme
2 parents 85edd33 + 494bfd1 commit 5b60a86

File tree

3 files changed

+40
-52
lines changed

3 files changed

+40
-52
lines changed

README.md

Lines changed: 40 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -1,83 +1,71 @@
1-
<img src="Iterable-Logo.svg">
1+
![Iterable logo](./images/Iterable-Logo.png "Iterable Logo")
22

3+
[![License](https://img.shields.io/cocoapods/l/Iterable-iOS-SDK.svg?style=flat)](https://opensource.org/licenses/MIT)
34
[![Build Status](https://travis-ci.org/Iterable/iterable-android-sdk.svg?branch=master)](https://travis-ci.org/Iterable/iterable-android-sdk)
45
[![codecov](https://codecov.io/gh/Iterable/iterable-android-sdk/branch/master/graph/badge.svg)](https://codecov.io/gh/Iterable/iterable-android-sdk)
56
[![Download](https://api.bintray.com/packages/davidtruong/maven/Iterable-SDK/images/download.svg)](https://bintray.com/davidtruong/maven/Iterable-SDK/_latestVersion)
67

7-
# Iterable Android SDK
8+
# Iterable's Android SDK
89

9-
The Iterable Android SDK is a Java implementation of an Android client for Iterable, supporting Android API versions 15 and higher.
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.
1014

11-
## Installation
12-
13-
- [Installation and configuration of the Iterable Android SDK](https://support.iterable.com/hc/articles/360035019712-Iterable-s-Android-SDK-)
14-
15-
## Sample apps
15+
This SDK helps you integrate your Android apps with Iterable. It supports
16+
Android API versions 15+.
1617

17-
This repository contains the following sample apps:
18+
## Installation
1819

19-
- [Inbox Customization](https://github.com/Iterable/iterable-android-sdk/tree/master/sample-apps/inbox-customization)
20+
For installation instructions, read [Iterable's Android SDK](https://support.iterable.com/hc/articles/360035019712).
2021

21-
## Using the SDK
22+
## Features
2223

23-
### Push notifications
24+
To learn more about various SDK features, read:
2425

26+
- [Identifying the User](https://support.iterable.com/hc/articles/360035402531)
27+
- [Updating User Profiles](https://support.iterable.com/hc/articles/360035402611)
28+
- [Tracking Events](https://support.iterable.com/hc/articles/360035395671)
2529
- [Setting up Android Push Notifications](https://support.iterable.com/hc/articles/115000331943)
30+
- [In-App Messages on Android](https://support.iterable.com/hc/articles/360035537231)
31+
- [Setting up Mobile Inbox on Android](https://support.iterable.com/hc/articles/360038744152)
32+
- [Customizing Mobile Inbox on Android](https://support.iterable.com/hc/articles/360039189931)
33+
- [Android App Links](https://support.iterable.com/hc/articles/360035127392)
34+
- [Deep Links in Push Notifications](https://support.iterable.com/hc/articles/360035453971)
35+
- [Deferred Deep Linking](https://support.iterable.com/hc/articles/360035165872)
2636

27-
### Deep linking
28-
29-
A deep link is a URI that links to a specific location within your mobile
30-
app. The following sections describe how to work with deep links using
31-
Iterable's Android SDK.
32-
33-
- [Deep Links in Push Notifications](https://support.iterable.com/hc/en-us/articles/360035453971#android-deep-links)
34-
- [Android App Links](https://support.iterable.com/hc/en-us/articles/360035127392)
35-
- [Deferred deep linking](https://support.iterable.com/hc/articles/360035165872)
36-
37-
### In-app messages
37+
## Sample projects
3838

39-
- [In-App Messages on Android](https://support.iterable.com/hc/en-us/articles/360035537231)
39+
For sample code, take a look at:
4040

41-
### Mobile Inbox
41+
- [Inbox Customization](https://github.com/Iterable/iterable-android-sdk/tree/master/sample-apps/inbox-customization)
4242

43-
Apps using version 3.2.0 and later of this SDK can allow users to save in-app
44-
messages to an inbox. This inbox displays a list of saved in-app messages and
45-
allows users to read them at their convenience. The SDK provides a default user
46-
interface for the inbox, which can be customized to match your brand's styles.
43+
## Release notes, support and troubleshooting
4744

48-
To learn more about Mobile Inbox, how to customize it, and events related to
49-
its usage, read:
45+
Release notes:
5046

51-
- [In-App Messages and Mobile Inbox](https://support.iterable.com/hc/articles/217517406)
52-
- [Sending In-App Messages](https://support.iterable.com/hc/articles/360034903151)
53-
- [Events for In-App Messages and Mobile Inbox](https://support.iterable.com/hc/articles/360038939972)
54-
- [Setting up Mobile Inbox on Android](https://support.iterable.com/hc/articles/360038744152)
55-
- [Customizing Mobile Inbox on Android](https://support.iterable.com/hc/articles/360039189931)
47+
- [Android SDK Release Notes](https://support.iterable.com/hc/articles/360027543332) (major releases)
48+
- [Releases page](https://github.com/Iterable/iterable-android-sdk/releases) on GitHub (minor releases)
5649

57-
### Tracking custom events
50+
Support policies:
5851

59-
- [Custom events](https://support.iterable.com/hc/articles/360035395671)
60-
61-
### User fields
52+
- Iterable's [Mobile SDK Support Policy](https://support.iterable.com/hc/articles/360027543332#mobile-sdk-support-policy)
53+
- Iterable's [iOS SDK Deprecation and End-of-Life Schedule](https://support.iterable.com/hc/articles/360027543332#android-sdk-deprecation-and-end-of-life-schedule)
6254

63-
- [Updating User Profiles](https://support.iterable.com/hc/articles/360035402611)
64-
65-
### Uninstall tracking
66-
67-
- [Uninstall tracking](https://support.iterable.com/hc/articles/205730229#uninstall)
55+
Troubleshooting:
6856

69-
## Additional information
57+
- [Testing and Troubleshooting Iterable's Mobile SDKs](https://support.iterable.com/hc/articles/360035392251)
58+
- [Frequently Asked Questions](https://support.iterable.com/hc/articles/360035624191)
59+
for mobile developers integrating with Iterable
7060

71-
For more information, take a look at Iterable's [Mobile Developer Guides](https://support.iterable.com/hc/categories/360002288712).
61+
Please contact your customer success manager with any questions.
7262

7363
## License
7464

75-
The MIT License
76-
77-
See [LICENSE](https://github.com/Iterable/iterable-android-sdk/blob/master/LICENSE)
65+
This SDK is released under the MIT License. See [LICENSE](https://github.com/Iterable/iterable-android-sdk/blob/master/LICENSE?raw=true)
66+
for more information.
7867

7968
## Want to contribute?
8069

81-
This library is open source, and we will look at pull requests!
82-
70+
This library is open source, and we will look at issue reports and pull requests.
8371
See [CONTRIBUTING](CONTRIBUTING.md) for more information.

images/Iterable-Logo.png

13.5 KB
Loading

images/push-integration-name.png

-52 KB
Binary file not shown.

0 commit comments

Comments
 (0)