Skip to content

Commit bba50ac

Browse files
Refine doc
1 parent 605003a commit bba50ac

File tree

1 file changed

+35
-39
lines changed

1 file changed

+35
-39
lines changed

README.md

Lines changed: 35 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,3 @@
1-
# OneSignal Android Sample
2-
3-
Sample app demonstrating integrating the OneSignal SDK into an Android project built with Kotlin.
4-
5-
## Requirements
6-
7-
* Android Studio Chipmunk.
8-
* OneSignal account and project.
9-
* Firebase Server Key.
10-
* Physical or virtual device.
11-
12-
## Usage
13-
To test this example, clone this repository as follows:
14-
>
15-
> $ git clone https://github.com/OneSignalDevelopers/OneSignal-Android-Push-Sample
16-
17-
In Android Studio:
18-
19-
1. Open the project.
20-
1. Click the green play icon to run the app.
21-
22-
23-
![OneSignal](https://github.com/OneSignalDevelopers/.github/blob/main/assets/onesignal-banner.png?raw=true)
24-
251
<div align="center">
262
<a href="https://documentation.onesignal.com/docs/onboarding-with-onesignal" target="_blank">Quickstart</a>
273
<span>&nbsp;&nbsp;&nbsp;&nbsp;</span>
@@ -31,36 +7,56 @@ In Android Studio:
317
<span>&nbsp;&nbsp;&nbsp;&nbsp;</span>
328
<a href="https://github.com/OneSignalDevelopers" target="_blank">Examples</a>
339
<br />
34-
<hr />
10+
<br />
3511
</div>
3612

13+
![OneSignal](https://github.com/OneSignalDevelopers/.github/blob/main/assets/onesignal-banner.png?raw=true)
14+
3715
# OneSignal Android Sample
3816

3917
OneSignal makes engaging customers simple and is the fastest, most reliable service to send push notifications, in-app messages, SMS, and emails.
4018

41-
This project demonstrates sending push notifications using **OneSignal Android SDK**. You can use this project as a boilerplate or reference to start your project.
19+
This project demonstrates integrating the OneSignal SDK into an Android project built with Kotlin. You can use this project as a boilerplate or reference to start your project.
4220

4321
## 🚦 Getting started
4422

4523
This project assumes that you already have a OneSignal app created with push notifications setup. If you don't yet have a OneSignal app, [create one](https://documentation.onesignal.com/docs/apps-organizations#create-an-app) first, then follow the steps below to integrate the OneSignal SDK into your [Android](https://documentation.onesignal.com/docs/android-sdk-setup) or [iOS](https://documentation.onesignal.com/docs/ios-sdk-setup) app.
4624

47-
### Initialize OneSignal
25+
### Requirements
26+
27+
* Android Studio Chipmunk.
28+
* OneSignal account and project.
29+
* Firebase Server Key.
30+
* Physical or virtual device.
31+
32+
### Usage
33+
34+
To test this example, clone this repository as follows:
35+
36+
`git clone https://github.com/OneSignalDevelopers/OneSignal-Android-Push-Sample`
37+
38+
In Android Studio:
39+
40+
1. Open the project.
41+
2. Click the green play icon to run the app.
42+
43+
#### Initialize OneSignal
4844

49-
https://github.com/OneSignalDevelopers/onesignal-android-sample/blob/3e5493fe01b67eb294ff071d695c081479d0c895/app/src/main/java/com/onesignal/sample/android/MainApplication.kt#L8-L14
45+
<https://github.com/OneSignalDevelopers/onesignal-android-sample/blob/3e5493fe01b67eb294ff071d695c081479d0c895/app/src/main/java/com/onesignal/sample/android/MainApplication.kt#L8-L14>
5046

51-
### Enable push subscription
47+
#### Enable push subscription
5248

53-
https://github.com/OneSignalDevelopers/onesignal-android-sample/blob/3e5493fe01b67eb294ff071d695c081479d0c895/app/src/main/java/com/onesignal/sample/android/MainActivity.kt#L21-L23
49+
<https://github.com/OneSignalDevelopers/onesignal-android-sample/blob/3e5493fe01b67eb294ff071d695c081479d0c895/app/src/main/java/com/onesignal/sample/android/MainActivity.kt#L21-L23>
5450

55-
### Send push notification
51+
#### Send push notification
5652

5753
```bash
5854
## Send notification
5955
# https://documentation.onesignal.com/reference/create-notification
6056
curl -X "POST" "http://notifications" \
61-
-H 'Content-Type: application/json' \
62-
-u '<Your REST API Key>:' \
63-
-d $'{
57+
-H 'Content-Type: application/json' \
58+
-u '<Your REST API Key>:' \
59+
-d $'{
6460
"headings": {
6561
"en": "🥳🍾🎊"
6662
},
@@ -137,11 +133,11 @@ For additional resources, please join the [OneSignal Developer Community](https:
137133

138134
Get in touch with us or learn more about OneSignal through the channels below.
139135

140-
- [Follow us on Twitter](https://twitter.com/onesignaldevs) to never miss any updates from the OneSignal team, ecosystem & community
141-
- [Join us on Discord](https://discord.gg/EP7gf6Uz7G) to be a part of the OneSignal Developers community, showcase your work and connect with other OneSignal developers
142-
- [Read the OneSignal Blog](https://onesignal.com/blog/) for the latest announcements, tutorials, in-depth articles & more.
143-
- [Subscribe to us on YouTube](https://www.youtube.com/channel/UCe63d5EDQsSkOov-bIE_8Aw/featured) for walkthroughs, courses, talks, workshops & more.
144-
- [Follow us on Twitch](https://www.twitch.tv/onesignaldevelopers) for live streams, office hours, support & more.
136+
* [Follow us on Twitter](https://twitter.com/onesignaldevs) to never miss any updates from the OneSignal team, ecosystem & community
137+
* [Join us on Discord](https://discord.gg/EP7gf6Uz7G) to be a part of the OneSignal Developers community, showcase your work and connect with other OneSignal developers
138+
* [Read the OneSignal Blog](https://onesignal.com/blog/) for the latest announcements, tutorials, in-depth articles & more.
139+
* [Subscribe to us on YouTube](https://www.youtube.com/channel/UCe63d5EDQsSkOov-bIE_8Aw/featured) for walkthroughs, courses, talks, workshops & more.
140+
* [Follow us on Twitch](https://www.twitch.tv/onesignaldevelopers) for live streams, office hours, support & more.
145141

146142
## Show your support
147143

0 commit comments

Comments
 (0)