Permalink
Browse files

Updated the README.md to reflect new changes to the plugin's methods …

…and arguments
  • Loading branch information...
1 parent f08b690 commit 72132370eca8d153d18c23885e62e3b39a561972 @JonLim JonLim committed Aug 15, 2011
Showing with 2 additions and 0 deletions.
  1. +2 −0 README.md
View
@@ -45,6 +45,8 @@ After that, you should be good to go. Load the module in your app and call the `
var postageapp = require('postageapp')('YOUR API KEY HERE');
postageapp.sendMessage(options);
+**NOTE:** The function has been renamed to `sendMessage()` so that this plugin will be more flexible going forward, for when we expand the API.
+
The `options` parameter on the `sendMessage()` function is a hash that contains all of the arguments that you will be using in your API call. Here is an example API call:
var options = {

0 comments on commit 7213237

Please sign in to comment.