Skip to content

Commit 9409ff2

Browse files
committed
improve examples readme
1 parent 3664dbc commit 9409ff2

File tree

1 file changed

+35
-10
lines changed

1 file changed

+35
-10
lines changed

examples/demo/README.md

Lines changed: 35 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,41 @@
1-
# demo
1+
# OneSignal Flutter SDK Demo
22

3-
A new Flutter project.
3+
A demo app showcasing all OneSignal Flutter SDK features including push notifications, in-app messaging, user management, tags, triggers, outcomes, and more.
44

5-
## Getting Started
5+
## Prerequisites
66

7-
This project is a starting point for a Flutter application.
7+
- Flutter 3.7+
8+
- Android emulator or iOS simulator (or a physical device)
9+
- For iOS: Xcode with a valid signing configuration
810

9-
A few resources to get you started if this is your first Flutter project:
11+
## Setup
1012

11-
- [Lab: Write your first Flutter app](https://docs.flutter.dev/get-started/codelab)
12-
- [Cookbook: Useful Flutter samples](https://docs.flutter.dev/cookbook)
13+
```bash
14+
flutter pub get
15+
```
1316

14-
For help getting started with Flutter development, view the
15-
[online documentation](https://docs.flutter.dev/), which offers tutorials,
16-
samples, guidance on mobile development, and a full API reference.
17+
For iOS, install CocoaPods dependencies:
18+
19+
```bash
20+
cd ios && pod install && cd ..
21+
```
22+
23+
## Run
24+
25+
```bash
26+
flutter run
27+
```
28+
29+
If multiple devices are connected, select one when prompted or specify it:
30+
31+
```bash
32+
flutter run -d <device_id>
33+
```
34+
35+
## Configuration
36+
37+
The app uses a default OneSignal App ID for testing. To use your own, update the `oneSignalAppId` constant in `lib/main.dart`.
38+
39+
## Build Guide
40+
41+
See [../build.md](../build.md) for the full set of prompts and requirements used to build this app.

0 commit comments

Comments
 (0)