From 398b9eb145134e81f839efd52c75d66e5c11f9b9 Mon Sep 17 00:00:00 2001 From: Bilal Abdeen Date: Sat, 8 Jan 2022 15:21:07 +1100 Subject: [PATCH 1/3] 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. --- website/docs/docs/getting-started.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/website/docs/docs/getting-started.md b/website/docs/docs/getting-started.md index 8e5326ed0..aa56d5666 100644 --- a/website/docs/docs/getting-started.md +++ b/website/docs/docs/getting-started.md @@ -11,6 +11,11 @@ We also assume you use `react-native@60.x.x` and above. For older versions, visit this [installation guide](https://github.com/wix/react-native-notifications/blob/v2/docs/installation.md). +## Introduction +This library supports 2 kinds of motifications. +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) +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). + ## Add react-native-notifications to your dependencies Date: Sat, 8 Jan 2022 15:48:45 +1100 Subject: [PATCH 2/3] Update getting-started.md --- website/docs/docs/getting-started.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/docs/getting-started.md b/website/docs/docs/getting-started.md index aa56d5666..1b8c79b60 100644 --- a/website/docs/docs/getting-started.md +++ b/website/docs/docs/getting-started.md @@ -14,7 +14,7 @@ For older versions, visit this [installation guide](https://github.com/wix/react ## Introduction This library supports 2 kinds of motifications. 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) -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). +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, on some server/db, 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). ## Add react-native-notifications to your dependencies From d351e43d6701324b61efe873ba2f08e196654f65 Mon Sep 17 00:00:00 2001 From: Bilal Abdeen Date: Sat, 8 Jan 2022 16:20:12 +1100 Subject: [PATCH 3/3] Update getting-started.md --- website/docs/docs/getting-started.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/website/docs/docs/getting-started.md b/website/docs/docs/getting-started.md index 1b8c79b60..c626f68a0 100644 --- a/website/docs/docs/getting-started.md +++ b/website/docs/docs/getting-started.md @@ -13,8 +13,8 @@ For older versions, visit this [installation guide](https://github.com/wix/react ## Introduction This library supports 2 kinds of motifications. -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) -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, on some server/db, 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). +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 SENDING local notification, please, refer to [Local Notifications](https://github.com/wix/react-native-notifications/edit/master/website/docs/docs/localNotifications.md) +2. Push Notifications. These notifications are sent by an application to any device through a communication/push server. This library provides support for RECEIVING push notifications. For push notifications to work, you need to (1) register the devices, which can receive notifications, on some server/db, 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). To send a notification you need to use a communication/push server. SENDING push notifications is NOT part of this library. ## Add react-native-notifications to your dependencies