Skip to content

Commit

Permalink
Edited README
Browse files Browse the repository at this point in the history
  • Loading branch information
Jim Remsik and Sandro Turriate authored and Wes Gibbs committed Jun 24, 2009
1 parent f9a8cb9 commit 3b3c8c7
Showing 1 changed file with 33 additions and 2 deletions.
35 changes: 33 additions & 2 deletions README.textile
@@ -1,7 +1,38 @@
h1. my_emma

Description goes here.
p. Post requests to MyEmma.com's Remote Signup API.

h2. Installation

<pre>sudo gem install hashrocket-my_emma</pre>

h2. Usage

<pre><code>
>> MyEmma.credentials = {
:emma_account_id => '9999',
:signup_post => '8888',
:username => 'user',
:password => 'pass'
}
>> response = MyEmma.signup("test@example.com")
=> #<MyEmma::Response:0x11ba840 @response="1", @code=1>
>> response.success?
=> true
>> response.failed?
=> false
>> response.added_member?
=> true

>> response = MyEmma.signup("test@example.com")
=> #<MyEmma::Response:0x11ba840 @response="2", @code=2>
>> response.updated_member?
=> true

>> MyEmma.signup("joe@example.com", {:emma_member_name_first => "Joe", :emma_member_name_last => "Piscopo"})
=> #<MyEmma::Response:0x11809b0 @response="1", @code=1>
</code></pre>

h2. Copyright

Copyright (c) 2009 Hashrocket. See LICENSE for details.
Copyright (c) 2009 Hashrocket. See MIT_LICENSE for details.

0 comments on commit 3b3c8c7

Please sign in to comment.