Skip to content

Commit 398b9eb

Browse files
Bilal-AbdeenDanielEliraz
authored andcommitted
Added an introduction section
When I first read the documentation, I was confused about the relationship between the different sections of it (the documentation.) I think this introduction can help others get the big picture.
1 parent 6d1a7fa commit 398b9eb

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

website/docs/docs/getting-started.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,11 @@ We also assume you use `react-native@60.x.x` and above.
1111

1212
For older versions, visit this [installation guide](https://github.com/wix/react-native-notifications/blob/v2/docs/installation.md).
1313

14+
## Introduction
15+
This library supports 2 kinds of motifications.
16+
1. Local Notifications: These notifications are sent by an application to the device, on which it is running. The notification never leaves the device, on which the application is running. For more details on using these notification, please, refer to [Local Notifications](https://github.com/wix/react-native-notifications/edit/master/website/docs/docs/localNotifications.md)
17+
2. Push Notifications. These notifications are sent by an application to any device through a communication server. For push notifications to work, you need to (1) register the devices, which can receive notifications, and (2) setup notification listeneres on these devices. To register devices, please refer to [Subscription](https://github.com/wix/react-native-notifications/blob/master/website/docs/docs/subscription.md). To setup notification listeneres, please refer to [Events](https://github.com/wix/react-native-notifications/blob/master/website/docs/docs/notifications-events.md).
18+
1419
## Add react-native-notifications to your dependencies
1520

1621
<Tabs

0 commit comments

Comments
 (0)