Add a note on max payload size

groupme · Jul 12, 2011 · 2b81d2c · 2b81d2c
1 parent f86b479
commit 2b81d2c
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -54,6 +54,14 @@ work as well. Please keep in mind that Apple will close the connection
 whenever an error is returned, and `APN::Client.closed?` should be polled to
 check for disconnects.
 
+### Max Payload Size ###
+
+Apple enforces a limit of __256 bytes__ for the __entire payload__.
+
+We raise an `EM::APN::Notification::PayloadTooLarge` exception.
+
+How you truncate the message is up to you. Be especially careful when dealing with multi-byte payloads.
+
 ## TODO ##
 
  * Support the feedback API for dead tokens