[#136] README updated #141

ferigis · 2017-02-03T19:40:01Z

[close #136]

elbrujohalcon · 2017-02-03T19:52:05Z

README.md

+
+This lib is intended to allow you to write an APNs provider for [Apple Push Notificaion services (APNs)](https://developer.apple.com/library/content/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/APNSOverview.html) over HTTP2 in Erlang.
+
+Copyright (c) 2017 Inaka Labs SRL <support@inaka.net>, released under the MIT license


Should be Erlang Solutions Ltd.

And Apache 2

elbrujohalcon · 2017-02-03T19:54:17Z

README.md

+
+## Create connections
+
+After fill the `config` file and run `apns4erl` app we can start creating connections. As we mentioned before there are two types of connections. Both are created using the function `apns:connect/2` where the first argument is the type and the second one is the connection's name.


fill -> filling, run -> running

elbrujohalcon · 2017-02-03T19:54:36Z

README.md

+```
+Note `cert` and `token` define the type we want.
+
+Although `Apns4erl` is supervising the connections `apns:connect/2` returns the connection `pid` just in case you wanted monitor it.


wanted -> want to

elbrujohalcon · 2017-02-03T19:55:33Z

README.md

+
+In order to send Notifications over `Provider Certificate` connection we will use `apns:push_notification/3,4`.
+
+We would need the connection, a notification, the device ID and some http2 headers. The connection is the `atom` we used when run `apns:connect/2` for setting a name, the device ID is provided by Apple, the notification is a `map` with the data we want to send, that map will be encoded to json later and the http2 headers can be explicitly sent as a parameter using `apns:push_notification/4` or can be defined at the `config` file, in that case we would use `apns:push_notification/3`.


would -> will
when run -> when we executed

elbrujohalcon · 2017-02-03T19:57:58Z

README.md

+
+## Push Notifications over `Provider Authentication Tokens` connections
+
+This is the other way APNs allows to send notifications. In this case we don't need a certificate but we will need a `p8` file with the private key we will use to sign the token. Lets suppose Apple provides us the file `APNsAuthKey_KEYID12345.p8`. We have to fill the `config` file key `token_keyfile` with the path to that file.


allows -> allows you or allows us
Lets suppose -> Lets assume
Apple provides us the file … -> we've got the file … from Apple
We have -> We then have

elbrujohalcon · 2017-02-03T19:58:36Z

README.md

+
+You can find more info [here](https://developer.apple.com/library/content/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/CommunicatingwithAPNs.html)
+
+In order to push notification we will use `apns:push_notification_token/4,5`. we will need the same attributes we used sending a notification over `Provider Certificate` connections plus a signed `token`. This token has a 1 hour life, so that means we can generate one token and use it many times till it expires. Lets try.


push notification -> push notifications or push a notification

. we -> . We
we used sending -> we used when sending

elbrujohalcon · 2017-02-03T19:59:46Z

README.md

+<<"KEYID123456">>
+8> Token = apns:generate_token(TeamId, KeyID).
+
+=INFO REPORT==== 3-Feb-2017::13:15:34 ===


This info report should be prettified… or removed entirely

I vote for removing it

elbrujohalcon · 2017-02-03T20:25:20Z

README.md

+
+## Close connections
+
+Apple recommends us to keep our connections open and avoiding open and close very often. You can check the [Best Practices for Managing Connections](https://developer.apple.com/library/content/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/CommunicatingwithAPNs.html) section.


and avoiding open and close -> and avoid opening and closing

elbrujohalcon · 2017-02-03T20:25:40Z

README.md

+
+Apple recommends us to keep our connections open and avoiding open and close very often. You can check the [Best Practices for Managing Connections](https://developer.apple.com/library/content/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/CommunicatingwithAPNs.html) section.
+
+But when to close a connection makes sense `apns4erl` gives us the function `apns:close_connection/1` where the parameter is the connection's name. After using it the name will be available for new connections again.


to close -> closing

[#136] README updated

0a3fd57

ferigis added this to the 2.0.0 milestone Feb 3, 2017

ferigis assigned elbrujohalcon Feb 3, 2017

elbrujohalcon requested changes Feb 3, 2017

View reviewed changes

[#136] fixing grammar mistakes

cc3d808

elbrujohalcon requested changes Feb 3, 2017

View reviewed changes

[#136] fixing more grammar mistakes

d1bb6d4

elbrujohalcon approved these changes Feb 3, 2017

View reviewed changes

elbrujohalcon merged commit b404610 into master Feb 3, 2017

elbrujohalcon deleted the ferigis.136.update_doc branch February 3, 2017 20:29

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[#136] README updated #141

[#136] README updated #141

ferigis commented Feb 3, 2017

elbrujohalcon Feb 3, 2017

elbrujohalcon Feb 3, 2017

elbrujohalcon Feb 3, 2017

elbrujohalcon Feb 3, 2017

elbrujohalcon Feb 3, 2017

elbrujohalcon Feb 3, 2017

elbrujohalcon Feb 3, 2017

elbrujohalcon Feb 3, 2017

elbrujohalcon Feb 3, 2017

elbrujohalcon Feb 3, 2017

elbrujohalcon Feb 3, 2017

elbrujohalcon Feb 3, 2017


		This lib is intended to allow you to write an APNs provider for [Apple Push Notificaion services (APNs)](https://developer.apple.com/library/content/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/APNSOverview.html) over HTTP2 in Erlang.

		Copyright (c) 2017 Inaka Labs SRL <support@inaka.net>, released under the MIT license


		## Create connections

		After fill the `config` file and run `apns4erl` app we can start creating connections. As we mentioned before there are two types of connections. Both are created using the function `apns:connect/2` where the first argument is the type and the second one is the connection's name.


		In order to send Notifications over `Provider Certificate` connection we will use `apns:push_notification/3,4`.

		We would need the connection, a notification, the device ID and some http2 headers. The connection is the `atom` we used when run `apns:connect/2` for setting a name, the device ID is provided by Apple, the notification is a `map` with the data we want to send, that map will be encoded to json later and the http2 headers can be explicitly sent as a parameter using `apns:push_notification/4` or can be defined at the `config` file, in that case we would use `apns:push_notification/3`.


		## Push Notifications over `Provider Authentication Tokens` connections

		This is the other way APNs allows to send notifications. In this case we don't need a certificate but we will need a `p8` file with the private key we will use to sign the token. Lets suppose Apple provides us the file `APNsAuthKey_KEYID12345.p8`. We have to fill the `config` file key `token_keyfile` with the path to that file.


		You can find more info [here](https://developer.apple.com/library/content/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/CommunicatingwithAPNs.html)

		In order to push notification we will use `apns:push_notification_token/4,5`. we will need the same attributes we used sending a notification over `Provider Certificate` connections plus a signed `token`. This token has a 1 hour life, so that means we can generate one token and use it many times till it expires. Lets try.


		## Close connections

		Apple recommends us to keep our connections open and avoiding open and close very often. You can check the [Best Practices for Managing Connections](https://developer.apple.com/library/content/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/CommunicatingwithAPNs.html) section.


		Apple recommends us to keep our connections open and avoiding open and close very often. You can check the [Best Practices for Managing Connections](https://developer.apple.com/library/content/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/CommunicatingwithAPNs.html) section.

		But when to close a connection makes sense `apns4erl` gives us the function `apns:close_connection/1` where the parameter is the connection's name. After using it the name will be available for new connections again.

[#136] README updated #141

[#136] README updated #141

Conversation

ferigis commented Feb 3, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment