Skip to content

Added an introduction section #803

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Added an introduction section #803

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
398b9eb
Added an introduction section
Bilal-Abdeen Jan 8, 2022
c8e7087
Update getting-started.md
Bilal-Abdeen Jan 8, 2022
d351e43
Update getting-started.md
Bilal-Abdeen Jan 8, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions website/docs/docs/getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 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

<Tabs
Expand Down