Skip to content

Commit 638135c

Browse files
committed
Update README
• Updates our README to be consistent with our other SDK repos
1 parent d39635b commit 638135c

File tree

1 file changed

+24
-6
lines changed

1 file changed

+24
-6
lines changed

Diff for: README.md

+24-6
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,28 @@
1-
# onesignal [![Build Status](https://travis-ci.org/OneSignal/OneSignal-Flutter-SDK.svg?branch=master)](https://travis-ci.org/OneSignal/OneSignal-Flutter-SDK)
1+
<p align="center">
2+
<img src="https://onesignal.com/assets/common/logo_onesignal_color.png"/>
3+
</p>
24

3-
A new flutter plugin project.
5+
### OneSignal Flutter SDK [![Build Status](https://travis-ci.org/OneSignal/OneSignal-Flutter-SDK.svg?branch=master)](https://travis-ci.org/OneSignal/OneSignal-Flutter-SDK)
46

5-
## Getting Started
7+
---
68

7-
For help getting started with Flutter, view our online
8-
[documentation](https://flutter.io/).
9+
[OneSignal](https://onesignal.com/) is a free push notification service for mobile apps. This SDK makes it easy to integrate your Flutter iOS and/or Android apps with OneSignal.
910

10-
For help on editing plugin code, view the [documentation](https://flutter.io/platform-plugins/#edit-code).
11+
![alt text](https://onesignal.com/images/android_and_ios_notification_image.gif)
12+
13+
#### Installation
14+
See the [Setup Guide](https://documentation.onesignal.com/v5.0/docs/flutter-sdk-setup) for setup instructions.
15+
16+
#### Change Log
17+
See this repository's [release tags](https://github.com/onesignal/onesignal-flutter-sdk/releases) for a complete change log of every released version.
18+
19+
#### Support
20+
Please visit this repository's [Github issue tracker](https://github.com/onesignal/onesignal-flutter-sdk/issues) for feature requests and bug reports related specificly to the SDK.
21+
For account issues and support please contact OneSignal support from the [OneSignal.com](https://onesignal.com) dashboard.
22+
23+
#### Demo Project
24+
To make things easier, we have published a demo project in the `/example` folder of this repository.
25+
26+
#### Supports:
27+
* Tested from iOS 8 to iOS 11.3
28+
* Tested from Android 4.0.3 (API level 15) to Android 8.1 (27)

0 commit comments

Comments
 (0)