updated readme

Author: adrian7

.gitignore

@@ -1 +1,2 @@
-# Created by .ignore support plugin (hsz.mobi)
+vendor
+composer.lock

README.md

@@ -1,2 +1,35 @@
-# mailchimp-api
+# Devlib/MailChimp-API
+
 Simple MailChimp API Wrapper
+
+### Install
+`composer require devlib/mailchimp-api`
+
+### Usage
+```php
+use DevLib\API\MailChimp\MailChimp;
+
+$apiKey  = getenv('MC_API_KEY');
+$list_id = getenv('MC_LIST_ID');
+
+$api     = new MailChimp($apiKey, $list_id);
+```
+
+### Subscribe user
+```php
+use DevLib\API\MailChimp\MailChimp;
+use MailChimpAPIException
+
+$email = 'you@example.com';
+
+try{
+
+    $api->subscribe($email, [
+        'FNAME' => 'Emma',
+        'LNAME' => 'Doe'
+    ]);
+
+}catch(MailChimp\MailChimpAPIException $e){
+    echo ( 'Error: ' . $e->getMessage() );
+}
+```

src/API/MailChimp/MailChimp.php

@@ -1,8 +1,8 @@
 <?php
 /**
- * SMS Signin Gateway - Mailchimp API integration class
- * @author adrian7 (adrian@studentmoneysaver.co.uk)
- * @version 1.1
+ * MailChimp API Wrapper Main Class
+ * @author adrian7
+ * @version 1.0
  */
 
 namespace DevLib\API\MailChimp;

tests/unit/MailChimpTest.php

@@ -61,7 +61,7 @@ protected function _before() {
             $this->fail("Please provide the MAILCHIMP_LIST_ID env variable ... . ");
 
         //init wrapper
-        $this->wrapper = new \DevLib\API\MailChimp( $apiKey, $this->list_id );
+        $this->wrapper = new DevLib\API\MailChimp\MailChimp( $apiKey, $this->list_id );
 
     }