scrunchie 0.0.2 → 0.0.3

data/README.md

@@ -1,6 +1,6 @@
 # Scrunchie
 
-TODO: Write a gem description
+This gem interfaces with the Elastic Email's API at <http://www.elasticemail.com>.
 
 ## Installation
 
@@ -16,9 +16,26 @@ Or install it yourself as:
 
     $ gem install scrunchie
 
-## Usage
+## Example Usage
 
-TODO: Write usage instructions here
+Set the configuration in a file that is loaded by Rails autoload path or create a new folder in app/
+and set create a class to hold the email address you register at Elastic Email and the API key.
+
+    class CharmBlast
+      def initialize(params)
+        @params = params
+        @faraday = Scrunchie::Blast.new('your-email@address.com', 'your-authentication-token', 'Name of List')
+      end
+
+      def deliver
+        @resp = @faraday.create_contact(@params)
+        @parsed = Scrunchie::XML.parse(@resp.body)
+      end
+    end
+
+Get the response:
+
+    @resp = CharmBlast.new(email: 'email@address.com', first_name: 'email', last_name: 'address').deliver
 
 ## Contributing
 

data/lib/scrunchie/version.rb

@@ -1,3 +1,3 @@
 module Scrunchie
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scrunchie
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-03 00:00:00.000000000 Z
+date: 2013-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday