readme.md in esendex-0.2.3 vs readme.md in esendex-0.3.0

@@ -1,10 +1,10 @@
-# Esendex
+# Esendex Ruby SDK
 
 Ruby Gem for interacting with the Esendex API
 
-This is in very early stages of development but supports sending one or multiple messages using your account details
+This is in early stages of development but supports the primary requirements around sending and receiving messages.
 
 ## Usage
 
 ### Setting up
 
@@ -43,11 +43,11 @@
 
 ```ruby
 account = Account.new('EX23847')
 ```
 
-Multiple messages are sent by passing an array of `Messages` to the send_messages method
+Multiple messages are sent by passing an array of `Messages` to the `send_messages` method
 	
 ```ruby
 batch_id = account.send_messages([Message.new("07777111222", "Hello"), Message.new("07777111333", "Hi")])
 ```
 
@@ -66,19 +66,111 @@
 You will need to set the credentials as enviroment variables which can also be done inline
 
     rake esendex:send_message["<mobile_number>","<message_body>"] ESENDEX_USERNAME=<username> ESENDEX_PASSWORD=<password> ESENDEX_ACCOUNT=<account_reference>
 
 
-### Testing
+## Push Notifications
 
-		bundle exec rspec
-	
-will run specs, ie those in the root of the test folder
+You can configure your Esendex account to send Push Notifications when the following occur
 
++ MessageDeliveredEvent
++ MessageFailedEvent
++ InboundMessage
+
+While it is possible to poll our API to check the status of outbound messages and to check for new inbound messages, the recommended approach is to allow the Esendex Platform to notify your system when these events occur.
+
+To do this you need to setup web accessible end points to accept the notifications. These end points are configured in [Esendex Developer Tools](https://www.esendex.com/developertools).
+
+Classes are provided in the gem for deserialising the notifications: `MessageDeliveredEvent`, `MessageFailedEvent` and `InboundMessage`. They all expose a `.from_xml` method to support this.
+
+```ruby
+message = InboundMessage.from_xml request.body
+```
+
+### Rails 3
+
+In order to simplify receipt of push notifications for Rails 3 users, the gem ships with mountable Rails controllers to handle the receipt of these notifications.
+
+To mount the end points, add this to `routes.rb`
+
+```ruby
+RailsApp::Application.routes.draw do
+  ...
+  mount Esendex::Engine => "/esendex"
+end
+```
+
+To configure the behaviour in response to a notification, you need to configure a lambda to use.
+
+```ruby
+Esendex.message_delivered_event_handler = lambda { |notification| 
+  # process the notification
+}
+```
+
+Please be kind to us and don't perform anything potentially long running in this call back as our notifier may timeout the request and pass the notififation to the retry queue. 
+
+If you need to perform processing that may run for a longer time then using an async task system like [Resque](https://github.com/defunkt/resque) is recommended.
+
+All notification classes expose a `.to_hash` method and can be initialised from the hash for serialisatiion and deserialisation.
+
+For example:
+
+```ruby
+
+Esendex.inbound_message_handler = lambda { |notification| 
+  Resque.enqueue InboundMessageProcessor, notification.to_hash
+}
+
+class InboundMessageProcessor
+
+  def self.perform(notification)
+    message = Esendex::InboundMessage.new notification
+    # do some processing of the message here
+  end
+
+end
+``` 
+
+The handlers are defined as follows:
+
+| End Point| Config Setting | Notification Class | Developer Tools |
+| -------- | -------------- | ------------------ | --------------- |
+| /esendex/inbound_messages | Esendex.inbound_message_handler | InboundMessage | SMS received |
+| /esendex/message_delivered_events | Esendex.message_delivered_event_handler | MessageDeliveredEvent | SMS delivered |
+| /esendex/message_failed_events | Esendex.message_failed_event_handler | MessageFailedEvent | SMS failed |
+
+#### Errors
+
+When an error occur in the handler lambdas then the controller returns a `500` status along with some error information back to the the Esendex Platform. This information is emailed to the technical notifications contact for the account.
+
+The notification then enters the retry cycle. 
+
+Included by default is the backtrace for the error to assist you in identifying the issue. You can suppress backtrace with the following config option.
+
+```ruby
+Esendex.configure do |config|
+  config.suppress_error_backtrace = true
+end
+```
+
+## Testing
+
+    bundle exec rspec
+  
+Will run specs. The spec folder contains a dummy Rails project for testing the Rails Engine.
+
+This project also ships with a `Guardfile` so you can run tests continuously.
+
+    bundle exec guard
+
+
 ## Contributing
 
-Please fork as you see fit and let us know when you have something that should be part of the gem.
+We really welcome any thoughts or guidance on how this gem could best provide the hooks you need to consume our services in your applicaiton. Please fork and raise pull requests for any features you would like us to add or raise an [issue]((https://github.com/esendex/esendex.gem/issues)
 
+Customers with more pressing issues should contact our support teams via the usual local phone number or by email: [[e-mail]](mailto:[e-mail]).
+
 ## Copyright
 
-Copyright (c) 2011-13 Esendex Ltd. See LICENSE.txt for further details.
+Copyright (c) 2011-13 Esendex Ltd. See licence.txt for further details.