README.md in createsend-2.4.0 vs README.md in createsend-2.5.0
- old
+ new
@@ -6,14 +6,18 @@
## Installation
gem install createsend
+## Documentation
+
+Full documentation is hosted by [RubyDoc.info](http://rubydoc.info/gems/createsend/frames).
+
## Examples
### Basic usage
-Retrieve a list of all your clients.
+This example of listing all your clients demonstrates basic usage of the library:
require 'createsend'
CreateSend.api_key 'your_api_key'
@@ -22,16 +26,16 @@
clients.each do |c|
puts "#{c.ClientID}: #{c.Name}"
end
-Results in:
-
+Running this example will result in something like:
+
4a397ccaaa55eb4e6aa1221e1e2d7122: Client One
a206def0582eec7dae47d937a4109cb2: Client Two
### Handling errors
-If the createsend API returns an error, an exception will be thrown. For example, if you attempt to create a campaign and enter empty values for subject etc:
+If the Campaign Monitor API returns an error, an exception will be thrown. For example, if you attempt to create a campaign and enter empty values for subject etc:
require 'createsend'
CreateSend.api_key 'your_api_key'
\ No newline at end of file