Readme.md in minitel-0.3.0 vs Readme.md in minitel-0.4.0
- old
+ new
@@ -9,16 +9,23 @@
``` ruby
require 'minitel'
# create a client
client = Minitel::Client.new("https://user:pass@telex.heroku.com")
-# send a notifcation to the owner and collaborators of an app
-client.notify_app(app_uuid: '...', title: 'Something happened', body: 'here are the details')
+# send a notification to the owner and collaborators of an app
+client.notify_app(app_uuid: '...', title: 'Your database is on fire!', body: 'Sorry.')
# => {"id"=>"uuid of message"}
-# send a notifcation to a user
-client.notify_user(user_uuid: '...', title: 'Something happened', body: 'here are the details')
+# send a notification to a user
+client.notify_user(user_uuid: '...', title: 'Here is your invoice', body: 'You owe us 65k.')
# => {"id"=>"uuid of message"}
-# add folloup to a previous notificaiton
-client.notify_user(message_uuid: '...', body: 'here are even more details')
+# send a notification with an email action
+# see: https://developers.google.com/gmail/markup/reference/go-to-action
+client.notify_user(user_uuid: '...',
+ title: 'Here is your invoice',
+ body: 'You owe us 65k.',
+ action: { label: 'View Invoice', url: 'https://heroku.com/invoices/12345-12-98765'})
+
+# add folloup to a previous notification
+client.add_followup(message_uuid: '...', body: 'here are even more details')
```