diff --git a/README.md b/README.md index 35bb5e37..935ceb28 100644 --- a/README.md +++ b/README.md @@ -14,8 +14,8 @@ Installation Sending a message ----------------- -Construct a Nexmo::Client object and use the #send_message method to -send a message. For example: +Construct a Nexmo::Client object with your API credentials and call +the #send_message method to send a message. For example: ```ruby require 'nexmo' @@ -25,10 +25,14 @@ nexmo = Nexmo::Client.new(key: 'YOUR API KEY', secret: 'YOUR API SECRET') nexmo.send_message(from: 'Ruby', to: 'YOUR NUMBER', text: 'Hello world') ``` -This method call returns the message id if the message was sent successfully, -or raises an exception if there was an error. The Nexmo documentation contains -a [list of error codes](https://docs.nexmo.com/index.php/sms-api/send-message#response_code) -which may be useful for debugging exceptions. +This method call returns the message id and other details if the message +was sent successfully, or raises an exception if there was an error. + +The Nexmo documentation contains a [list of error codes](https://docs.nexmo.com/index.php/sms-api/send-message#response_code) +which may be useful for debugging exceptions. Remember that phone numbers +should be specified in international format, and other country specific +restrictions may apply (e.g. US messages must originate from either a +pre-approved long number or short code). Production environment variables @@ -39,11 +43,3 @@ to use environment variables, as described by [12factor.net/config](http://12fac Nexmo::Client defaults to extracting the api key/secret it needs from the NEXMO_API_KEY and NEXMO_API_SECRET environment variables if the key/secret options were not specified explicitly. - - -Troubleshooting ---------------- - -Remember that phone numbers should be specified in international format. - -Please report all bugs/issues via the GitHub issue tracker.