Skip to content

Commit 18ac210

Browse files
committed
Update readme
1 parent 6778a40 commit 18ac210

File tree

1 file changed

+25
-23
lines changed

1 file changed

+25
-23
lines changed

README.md

Lines changed: 25 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,37 @@
1-
![Dashboard Items](https://raw.github.com/BatchLabs/android-sdk/master/readme_logo.png)
1+
Batch.com iOS SDK
2+
==================
23

3-
# Batch Sample Apps
4-
The samples are minimal examples demonstrating proper integrations of the Batch SDK, including implementation of Batch Push functionality.
4+
![Logo](http://batch-doc.s3.amazonaws.com/logo_batch_192.gif)
55

6-
You will need an up-to-date SDK and Android Studio installation in order to properly use this sample.
6+
![Header](http://batch-doc.s3.amazonaws.com/General/BatchHeader.png)
77

8-
## App
8+
# About
99

10-
1. Clone or download the repository.
10+
Batch is the leading mobile engagement & push notification suite engineered for the mobile era.
1111

12-
2. Open the sample project in Android Studio.
12+
# Requirements
13+
- Android Studio 3.0+
14+
- Android 15+
1315

14-
## Dashboard
16+
# Installation
17+
Gradle (recommended)
1518

16-
### 1. Login to your [Batch.com](https://batch.com/) account or create a new one.
19+
```
20+
compile 'com.batch.android:batch-sdk:+'
21+
```
1722

18-
### 2. Add your new sample app
19-
Add a new app on the [dashboard](https://dashboard.batch.com/app/new) using the manual option, as your sample app doesn't have an App Store or Play Store URL to autopopulate.
23+
Manual
24+
You can find the AAR [here](https://batch.com/download/android)
2025

21-
### 3. Retrieve the dev API key
22-
Within your newly-created app, find the dev API key either here on step 1 of the wizard screen under `API KEY`, or in the settings menu under *API Keys*.
26+
## Using it
27+
Describing what Batch can do is a little too big for this README.
28+
Read our [setup documentation](https://batch.com/doc/android/sdk-integration.html) to follow a step by step tutorial for integrating Batch features into your app.
2329

24-
Place the dev API key in your sample app's `BatchSampleApplication.java`, in the startWithAPIKey method call.
30+
# Documentation
2531

26-
At this point, feel free to launch your app.
32+
- [Technical](https://batch.com/doc)
33+
- [Javadoc](https://batch.com/android-api-reference/index.html)
34+
- [FAQ](https://batch.com/doc/faq/general.html)
35+
- [Developer FAQ](https://batch.com/developers)
2736

28-
### 4. Testing Push
29-
30-
To test the push functionality, add your GCM Sender ID in `BatchSampleApplication.java`. Your token will be logged in your device's logcat, which you can use in the dashboard's test push function. This can be found on the Message screen of the push campaign creation wizard.
31-
You will also be able to change the notification settings from the main menu.
32-
33-
## Resources
34-
* [Full Batch documentation](https://dashboard.batch.com/doc)
35-
* [support@batch.com](support@batch.com)
37+
Copyright 2018 - Batch.com

0 commit comments

Comments
 (0)