Skip to content

Commit 936fb22

Browse files
committed
Readme update
1 parent f6e696d commit 936fb22

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,10 @@ https://github.com/nodes-ios/notificationsClients
2929
```
3030

3131
## 💻 Usage
32+
The package also includes an example project. If in doubt, check the code in the Example folder.
3233

3334
### Integrating the clients in your dependencies / environment
34-
For production code, just use the `.live()` static property.
35+
For production code, just use the `.live()` static property.
3536

3637
❗️ IMPORTANT❗️
3738
You must call the.`.live()` of `UserNotificationsClient` syncronously before the app delegate's `didFinishWithLaunching` returns. This makes sure the correct delegate is assigned to the `UNUserNotificationCenter.current()` and therefore the app can react to push notifications when opened from suspended state.
@@ -49,7 +50,7 @@ func application(
4950
}
5051

5152
func setupAppEnvironment() {
52-
let environment = AppEnvironment(remoteNotificationsClient: RemoteNotificationsClient.live(),
53+
let environment = AppEnvironment(remoteNotificationsClient: RemoteNotificationsClient.live,
5354
userNotificationsClient: UserNotificationsClient.live())
5455
}
5556
```
@@ -112,10 +113,10 @@ See the `Testing` DocC article inside the targets.
112113

113114
## Why the heck is Firebase not integrated in this already? 🔥
114115
Two reasons:
115-
1. `FirebaseMessaging` works unreliably outside the app's main target. You really want to set it up inside your app delegate.
116+
1. `FirebaseMessaging` works unreliably outside the app's main target. You really want to set it up inside your app's delegate.
116117
2. This is a generic implementation that should work regardless the push notifications source.
117118

118-
If you want to quickly integrate `FirebaseMessaging` with this, is most cases you just need to:
119+
If you want to quickly integrate `FirebaseMessaging` with this, in most cases you just need to:
119120
- Configure Firebase
120121
- Assign the Messaging delegate
121122
- Send the Firebase token to your backend

0 commit comments

Comments
 (0)