Skip to content

Commit 8d33aa1

Browse files
committed
updated readme with android icon installation step and marked steps that the link command does automagically for us
1 parent 11359ec commit 8d33aa1

File tree

1 file changed

+10
-6
lines changed

1 file changed

+10
-6
lines changed

README.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ Fast and easy:
1919
npm install react-native-local-notifications --save
2020
react-native link react-native-local-notifications
2121
```
22+
Keep in mind that the link step only links the project in the native projects, more steps have to be done for both platforms, which are described in the Android and iOS section below... please verify manually that the link command successfully linked the libray to your project!
2223

2324
Or manual: add the latest version as dependeny to your package.json.
2425

@@ -35,9 +36,9 @@ Or manual: add the latest version as dependeny to your package.json.
3536
```
3637

3738
#### iOS
38-
* Add RNLocalNotifications.xcoderproj into your project in the Libraries folder.
39-
* Add the .a file on the General tab of your target under Linked Frameworks And Libraries
40-
* Add the .a file on the Build Phases tab of your target under Link Binary With Libraries
39+
* {auto-link} Add RNLocalNotifications.xcoderproj into your project in the Libraries folder.
40+
* {auto-link}Add the .a file on the General tab of your target under Linked Frameworks And Libraries
41+
* {auto-link}Add the .a file on the Build Phases tab of your target under Link Binary With Libraries
4142
* In the AppDelegate.m file of your xcode project add:
4243
```
4344
- (void)applicationDidBecomeActive:(UIApplication *)application
@@ -72,16 +73,16 @@ Or manual: add the latest version as dependeny to your package.json.
7273
nMgr.cancelAll();
7374
}
7475
```
75-
* In the settings.gradle
76+
* {auto-link}In the settings.gradle
7677
```
7778
include ':react-native-local-notifications', ':app'
7879
project(':react-native-local-notifications').projectDir = new File(rootProject.projectDir, '../node_modules/react-native-local-notifications/android')
7980
```
80-
* In the build.gradle
81+
* {auto-link}In the build.gradle
8182
```
8283
compile project(':react-native-local-notifications')
8384
```
84-
* In MainApplication.java
85+
* {auto-link}In MainApplication.java
8586
```
8687
import com.github.wumke.RNLocalNotifications.RNLocalNotificationsPackage;
8788
...
@@ -95,6 +96,9 @@ Or manual: add the latest version as dependeny to your package.json.
9596
}
9697
...
9798
```
99+
* Aside from the big icon, for which the ic_launcher icon in mipmap folder is used by default, you also need a small transparent with white foreground icon which will be displayed in the status bar.
100+
See Android developer specifications for correct sizes, by default 'notification_small' from the drawable folder is used...
101+
98102
## Usage
99103
100104
####Examples:

0 commit comments

Comments
 (0)