diff --git a/README.textile b/README.textile index 9deac7d..e6a9353 100644 --- a/README.textile +++ b/README.textile @@ -1,7 +1,38 @@ h1. my_emma -Description goes here. +p. Post requests to MyEmma.com's Remote Signup API. + +h2. Installation + +
sudo gem install hashrocket-my_emma+ +h2. Usage + +
+>> MyEmma.credentials = {
+ :emma_account_id => '9999',
+ :signup_post => '8888',
+ :username => 'user',
+ :password => 'pass'
+ }
+>> response = MyEmma.signup("test@example.com")
+=> #
+>> response.success?
+=> true
+>> response.failed?
+=> false
+>> response.added_member?
+=> true
+
+>> response = MyEmma.signup("test@example.com")
+=> #
+>> response.updated_member?
+=> true
+
+>> MyEmma.signup("joe@example.com", {:emma_member_name_first => "Joe", :emma_member_name_last => "Piscopo"})
+=> #
+
h2. Copyright
-Copyright (c) 2009 Hashrocket. See LICENSE for details.
+Copyright (c) 2009 Hashrocket. See MIT_LICENSE for details.