Skip to content

Commit ba593d6

Browse files
committed
Update README
1 parent 9655afd commit ba593d6

File tree

9 files changed

+79
-9
lines changed

9 files changed

+79
-9
lines changed

README.md

Lines changed: 79 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,17 +6,87 @@
66

77
## Description
88

9-
- Icon http://emojione.com/
10-
- Use [node-apn](https://github.com/node-apn/node-apn) under the hood
11-
- Download from https://github.com/onmyway133/PushNotifications/releases
9+
- `PushNotitication` is an app used for testing push notifications on iOS and Android
10+
- Support macOS
11+
12+
## How to install
13+
14+
- Download latest release from https://github.com/onmyway133/PushNotifications/releases
15+
16+
## How to use
17+
18+
- [iOS Provider Certificate](#ios-provider-certificates)
19+
- [iOS Authentication Token](#ios-authentication-token)
20+
- [Android Server Key](#android-server-key)
21+
22+
### iOS Provider Certificate
23+
24+
- Read more [Provider Certificates](https://developer.apple.com/library/content/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/CommunicatingwithAPNs.html#//apple_ref/doc/uid/TP40008194-CH11-SW1)
25+
- Go to [Member Center](https://developer.apple.com/account/ios/certificate/distribution/create)
26+
- Generate `Apple Push Notification service SSL (Sandbox & Production)`, this is now used for both sandbox and production. Download as `.cer` file
27+
- Double click on `.cer` file to install into `Keychain`, then export it as `.p12` file
28+
29+
<div align = "center">
30+
<img src="Screenshots/Certificate.png" width="600"/>
31+
</div>
32+
33+
- In `PushNotifications`, select `.p12` file, fill out `passphase` if needed, fill out `bundle id`, `device token`, `message`, select `environment`
34+
- `message` must be in json format, see [Creating the Remote Notification Payload](https://developer.apple.com/library/content/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/CreatingtheNotificationPayload.html)
35+
36+
<div align = "center">
37+
<img src="Screenshots/iOSCertificate.png" width="600"/>
38+
</div>
39+
40+
### iOS Authentication Token
41+
42+
- Read more [Authentication Tokens](https://developer.apple.com/library/content/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/CommunicatingwithAPNs.html#//apple_ref/doc/uid/TP40008194-CH11-SW1)
43+
- Go to [Member Center](https://developer.apple.com/account/ios/certificate/distribution/create)
44+
- Create a `Key` for push notification. Download as `.p8` file.
45+
46+
<div align = "center">
47+
<img src="Screenshots/Key.png" width="600"/>
48+
</div>
49+
50+
- Note your `key id`
51+
52+
<div align = "center">
53+
<img src="Screenshots/KeyId.png" width="600"/>
54+
</div>
55+
56+
- Note your `team id` on [Account Membership](https://developer.apple.com/account/#/membership)
57+
58+
<div align = "center">
59+
<img src="Screenshots/TeamId.png" width="600"/>
60+
</div>
61+
62+
- In `PushNotifications`, select `.p8` file, fill out `key id`, `team id`, `bundle id`, `device token`, `message`, select `environment`
63+
64+
<div align = "center">
65+
<img src="Screenshots/iOSToken.png" width="600"/>
66+
</div>
67+
1268

13-
## Features
69+
### Android Server Key
1470

15-
- iOS
16-
- [Provider Certificates](https://developer.apple.com/library/content/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/CommunicatingwithAPNs.html#//apple_ref/doc/uid/TP40008194-CH11-SW1): need .p12 file
17-
- [Authentication Tokens](https://developer.apple.com/library/content/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/CommunicatingwithAPNs.html#//apple_ref/doc/uid/TP40008194-CH11-SW1): need .p8 file, key id, team id
18-
- Android
19-
- [Firebase Cloud Messaging](https://firebase.google.com/docs/cloud-messaging/): need server key
71+
- Read about [
72+
Firebase Cloud Messaging](https://firebase.google.com/docs/cloud-messaging/)
73+
- Add or select project on [Firebase Console](https://console.firebase.google.com/u/0/)
74+
75+
<div align = "center">
76+
<img src="Screenshots/AndroidServerKey.png" width="600"/>
77+
</div>
78+
79+
- In `PushNotifications`, fill out `server key`, `device token`, `message`
80+
- `message` must be in json format
81+
82+
<div align = "center">
83+
<img src="Screenshots/Android.png" width="600"/>
84+
</div>
85+
86+
## Credit
87+
88+
- Icon http://emojione.com/
89+
- Use [node-apn](https://github.com/node-apn/node-apn) under the hood
2090

2191

2292
## Author

Screenshots/Android.png

39 KB
Loading

Screenshots/AndroidServerKey.png

82.5 KB
Loading

Screenshots/Certificate.png

54.1 KB
Loading

Screenshots/Key.png

106 KB
Loading

Screenshots/KeyId.png

34.4 KB
Loading

Screenshots/TeamId.png

37.6 KB
Loading

Screenshots/iOSCertificate.png

57.8 KB
Loading

Screenshots/iOSToken.png

66.9 KB
Loading

0 commit comments

Comments
 (0)