Skip to content

Commit 5551c4f

Browse files
committed
doc: update doc
1 parent f5e3604 commit 5551c4f

File tree

2 files changed

+28
-6
lines changed

2 files changed

+28
-6
lines changed

.DS_Store

0 Bytes
Binary file not shown.

README.md

Lines changed: 28 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -121,9 +121,25 @@ You must be a member of the Apple Developer Program in order to enable Push Noti
121121

122122
![Instructions to add push notifications capability](https://i.stack.imgur.com/qsQTx.jpg)
123123

124-
#### Customize notification appearance on Android
124+
### Setup OneSignal
125125

126-
Starting Android 10 (API 29), notification icons should be glyphs. You need to follow this step to [customize the notification appearance](https://wix.github.io/react-native-notifications/docs/installation-android/#step-6-customize-the-appearance).
126+
1. You will need to have [OneSignal Account](https://app.onesignal.com/signup)
127+
2. Your OneSignal App ID, available in [Keys & IDs
128+
iOS.](https://documentation.onesignal.com/docs/accounts-and-keys#section-app-id)
129+
130+
3. IOS - [Generate an iOS Push Certificate.](https://documentation.onesignal.com/docs/generate-an-ios-push-certificate) You should generate a certificate after adding the Push Notification capability while setting up your iOS app.
131+
4. Android - [Generate a Google Firebase Server API Key](https://documentation.onesignal.com/docs/generate-a-google-server-api-key)
132+
5. Optional step for your application to use [Confirmed Deliveries](https://documentation.onesignal.com/docs/confirmed-deliveries) and and increment/decrement [Badges](https://documentation.onesignal.com/docs/badges) through push notifications, you need to set up an App Group for your application.
133+
134+
In your main app target go back to Signing & Capabilities > All > + Capability and add App Groups
135+
136+
![Instructions to add push notifications capability](https://files.readme.io/5b72690-Screen_Shot_2020-08-15_at_6.10.59_PM.png)
137+
138+
![Instructions to add push notifications capability](https://files.readme.io/2f271ce-Screen_Shot_2020-08-15_at_6.15.25_PM.png)
139+
140+
![Instructions to add push notifications capability](https://files.readme.io/230100f-c51bffb-Screen_Shot_2020-08-15_at_6.21.25_PM.png)
141+
142+
For more instructions and doubts, go to [Documentation Integration](https://documentation.onesignal.com/docs/react-native-sdk-setup#step-4-install-for-ios-using-cocoapods-for-ios-apps)
127143

128144
### Setup Code Push
129145

@@ -137,10 +153,6 @@ Starting Android 10 (API 29), notification icons should be glyphs. You need to f
137153

138154
You can retrieve this values by running `appcenter codepush deployment list -a <ownerName>/<appName> -k`
139155

140-
#### Add project email for the FileLogger
141-
142-
Update project email used by `sendLoggedFiles` method in `Home.tsx`
143-
144156
## Libraries
145157

146158
Let's briefly go over the benefit of each library included in this template.
@@ -193,6 +205,10 @@ A unified permissions API for React Native on iOS and Android. For iOS you have
193205

194206
Localization using hooks. [React Native example](https://github.com/i18next/react-i18next/tree/master/example/react-native)
195207

208+
### OneSignal
209+
210+
OneSignal is the fastest and most reliable service to send push notifications, in-app messages, and emails to your users on mobile
211+
196212
### Codepush
197213

198214
A React Native app is composed of JavaScript files and any accompanying images, which are bundled together by the packager and distributed as part of a platform-specific binary (i.e. an .ipa or .apk file). Once the app is released, updating either the JavaScript code (e.g. making bug fixes, adding new features) or image assets, requires you to recompile and redistribute the entire binary, which of course, includes any review time associated with the store(s) you are publishing to.
@@ -251,6 +267,12 @@ NPM scripts for running the app with the desired configuration are [included](ht
251267

252268
Necessary when creating complex gesture based animations that are highly performant.
253269

270+
### Lottie React Native
271+
272+
Lottie is a mobile library for Android and iOS that parses Adobe After Effects animations exported as JSON with bodymovin and renders them natively on mobile!
273+
274+
For the first time, designers can create and ship beautiful animations without an engineer painstakingly recreating it by hand.
275+
254276
### react-native-appstate-hook
255277

256278
Custom react hook, built to handle iOS or Android appState in your react component.

0 commit comments

Comments
 (0)