updated readme, fixed namespacing issue

README.md

@@ -1,31 +1,44 @@
-Welcome to Heap Helper
+# Heap Helper
+[![GitHub issues](https://img.shields.io/github/issues/mitquinn/HeapHelper)](https://github.com/mitquinn/HeapHelper/issues)
+[![GitHub stars](https://img.shields.io/github/stars/mitquinn/HeapHelper)](https://github.com/mitquinn/HeapHelper/stargazers)
+[![GitHub license](https://img.shields.io/github/license/mitquinn/HeapHelper)](https://github.com/mitquinn/HeapHelper/blob/master/LICENSE.md)
 
-This is a composer package the assists with the Heap server side API.
+## Description
+Heap Helper is a simple wrapper for the Heap server side API.
 
-Developed by:
-Mitchell Quinn <mdq2@live.com>
+Heap Helper provides:
+* simple integration with the Heap server side API.
+* wrapper for the Heap API endpoints. 
+* individual resources that the API is expecting to be provided.
 
 You can learn more about Heap here: https://heapanalytics.com/
 
+```php
+$configuration = new \Mitquinn\HeapHelper\HeapConfiguration('apiKey', 'appId');
+$heapHelper = new \Mitquinn\HeapHelper\HeapHelper($configuration);
+
+$event = new \Mitquinn\HeapHelper\Resources\HeapEvent(
+    'eventName', 
+    'alice@example.com', 
+    ['propertyKey' => 'propertyValue']
+);
+
+$heapResponse = $heapHelper->track($event);
+```
+
+## Installation
+The recommended way to install Heap Helper is through [Composer.](https://getcomposer.org/)
+```
+composer require mitquinn/heap-helper
+```
+
+## License
+Heap Helper is made available under the GNU General Public License (GNU). Please see the [License File](https://github.com/mitquinn/HeapHelper/blob/master/LICENSE.md) for more information.
+
+## Contributors
+
+* Sponsor - Mitchell Quinn - [<mitchell.david.quinn@gmail.com>](mailto:mitchell.david.quinn@gmail.com)
+
 
-Main Work TODO:
-* AddUserProperties API
-* AddUserProperties Resource
-* BulkAddUserProperties API
-* BulkAddUserProperties Resource
-* AddAccountProperties API
-* User Deletion API
-* Auth API
-
-Testing Work TODO:
-* Event Resource
-* Events Resource
-* AddUserProperties API
-* AddUserProperties Resource
-* BulkAddUserProperties API
-* BulkAddUserProperties Resource
-* AddAccountProperties API
-* User Deletion API
-* Auth API
 
 

composer.json

@@ -21,7 +21,7 @@
     },
     "autoload": {
         "psr-4": {
-            "Mquinn\\HeapHelper\\": "src/"
+            "Mitquinn\\HeapHelper\\": "src/"
         }
     },
     "minimum-stability": "stable"

src/HeapConfiguration.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace Mquinn\HeapHelper;
+namespace Mitquinn\HeapHelper;
 
 class HeapConfiguration
 {

src/HeapHelper.php

@@ -1,16 +1,16 @@
 <?php
 
-namespace Mquinn\HeapHelper;
+namespace Mitquinn\HeapHelper;
 
 use GuzzleHttp\Client;
 use GuzzleHttp\Psr7\Request;
-use Mquinn\HeapHelper\Interfaces\HeapHelperInterface;
-use Mquinn\HeapHelper\Resources\HeapAccount;
-use Mquinn\HeapHelper\Resources\HeapAccounts;
-use Mquinn\HeapHelper\Resources\HeapEvent;
-use Mquinn\HeapHelper\Resources\HeapEvents;
-use Mquinn\HeapHelper\Resources\HeapUser;
-use Mquinn\HeapHelper\Resources\HeapUsers;
+use Mitquinn\HeapHelper\Interfaces\HeapHelperInterface;
+use Mitquinn\HeapHelper\Resources\HeapAccount;
+use Mitquinn\HeapHelper\Resources\HeapAccounts;
+use Mitquinn\HeapHelper\Resources\HeapEvent;
+use Mitquinn\HeapHelper\Resources\HeapEvents;
+use Mitquinn\HeapHelper\Resources\HeapUser;
+use Mitquinn\HeapHelper\Resources\HeapUsers;
 use PHPUnit\Util\Xml\ValidationResult;
 use Psr\Http\Client\ClientExceptionInterface;
 use Psr\Http\Client\ClientInterface;

src/HeapResponse.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace Mquinn\HeapHelper;
+namespace Mitquinn\HeapHelper;
 
 use GuzzleHttp\Psr7\Response;
 use Psr\Http\Message\ResponseInterface;

src/Interfaces/HeapHelperInterface.php

@@ -1,14 +1,14 @@
 <?php
 
-namespace Mquinn\HeapHelper\Interfaces;
+namespace Mitquinn\HeapHelper\Interfaces;
 
-use Mquinn\HeapHelper\HeapResponse;
-use Mquinn\HeapHelper\Resources\HeapAccount;
-use Mquinn\HeapHelper\Resources\HeapAccounts;
-use Mquinn\HeapHelper\Resources\HeapEvent;
-use Mquinn\HeapHelper\Resources\HeapEvents;
-use Mquinn\HeapHelper\Resources\HeapUser;
-use Mquinn\HeapHelper\Resources\HeapUsers;
+use Mitquinn\HeapHelper\HeapResponse;
+use Mitquinn\HeapHelper\Resources\HeapAccount;
+use Mitquinn\HeapHelper\Resources\HeapAccounts;
+use Mitquinn\HeapHelper\Resources\HeapEvent;
+use Mitquinn\HeapHelper\Resources\HeapEvents;
+use Mitquinn\HeapHelper\Resources\HeapUser;
+use Mitquinn\HeapHelper\Resources\HeapUsers;
 
 interface HeapHelperInterface
 {

src/Interfaces/HeapResourceInterface.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace Mquinn\HeapHelper\Interfaces;
+namespace Mitquinn\HeapHelper\Interfaces;
 
 interface HeapResourceInterface
 {

src/Resources/HeapAccount.php

@@ -1,11 +1,11 @@
 <?php
 
-namespace Mquinn\HeapHelper\Resources;
+namespace Mitquinn\HeapHelper\Resources;
 
 use JetBrains\PhpStorm\ArrayShape;
 use JetBrains\PhpStorm\Pure;
-use Mquinn\HeapHelper\Interfaces\HeapResourceInterface;
-use Mquinn\HeapHelper\Traits\HasProperties;
+use Mitquinn\HeapHelper\Interfaces\HeapResourceInterface;
+use Mitquinn\HeapHelper\Traits\HasProperties;
 
 class HeapAccount implements HeapResourceInterface
 {

src/Resources/HeapAccounts.php

@@ -1,9 +1,9 @@
 <?php
 
-namespace Mquinn\HeapHelper\Resources;
+namespace Mitquinn\HeapHelper\Resources;
 
 use JetBrains\PhpStorm\Pure;
-use Mquinn\HeapHelper\Interfaces\HeapResourceInterface;
+use Mitquinn\HeapHelper\Interfaces\HeapResourceInterface;
 
 class HeapAccounts implements HeapResourceInterface
 {

src/Resources/HeapEvent.php

@@ -1,15 +1,15 @@
 <?php
 
-namespace Mquinn\HeapHelper\Resources;
+namespace Mitquinn\HeapHelper\Resources;
 
 
 use DateTime;
 use InvalidArgumentException;
 use JetBrains\PhpStorm\ArrayShape;
 use JetBrains\PhpStorm\Pure;
-use Mquinn\HeapHelper\Interfaces\HeapResourceInterface;
-use Mquinn\HeapHelper\Traits\HasHeapUserIdentity;
-use Mquinn\HeapHelper\Traits\HasProperties;
+use Mitquinn\HeapHelper\Interfaces\HeapResourceInterface;
+use Mitquinn\HeapHelper\Traits\HasHeapUserIdentity;
+use Mitquinn\HeapHelper\Traits\HasProperties;
 
 class HeapEvent implements HeapResourceInterface
 {

src/Resources/HeapEvents.php

@@ -1,9 +1,9 @@
 <?php
 
-namespace Mquinn\HeapHelper\Resources;
+namespace Mitquinn\HeapHelper\Resources;
 
 use JetBrains\PhpStorm\Pure;
-use Mquinn\HeapHelper\Interfaces\HeapResourceInterface;
+use Mitquinn\HeapHelper\Interfaces\HeapResourceInterface;
 
 class HeapEvents implements HeapResourceInterface
 {

src/Resources/HeapUser.php

@@ -1,12 +1,12 @@
 <?php
 
-namespace Mquinn\HeapHelper\Resources;
+namespace Mitquinn\HeapHelper\Resources;
 
 use JetBrains\PhpStorm\ArrayShape;
 use JetBrains\PhpStorm\Pure;
-use Mquinn\HeapHelper\Interfaces\HeapResourceInterface;
-use Mquinn\HeapHelper\Traits\HasHeapUserIdentity;
-use Mquinn\HeapHelper\Traits\HasProperties;
+use Mitquinn\HeapHelper\Interfaces\HeapResourceInterface;
+use Mitquinn\HeapHelper\Traits\HasHeapUserIdentity;
+use Mitquinn\HeapHelper\Traits\HasProperties;
 
 class HeapUser implements HeapResourceInterface
 {

src/Resources/HeapUsers.php

@@ -1,9 +1,9 @@
 <?php
 
-namespace Mquinn\HeapHelper\Resources;
+namespace Mitquinn\HeapHelper\Resources;
 
 use JetBrains\PhpStorm\Pure;
-use Mquinn\HeapHelper\Interfaces\HeapResourceInterface;
+use Mitquinn\HeapHelper\Interfaces\HeapResourceInterface;
 
 class HeapUsers implements HeapResourceInterface
 {

src/Traits/HasHeapUserIdentity.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace Mquinn\HeapHelper\Traits;
+namespace Mitquinn\HeapHelper\Traits;
 
 use InvalidArgumentException;
 

src/Traits/HasProperties.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace Mquinn\HeapHelper\Traits;
+namespace Mitquinn\HeapHelper\Traits;
 
 use InvalidArgumentException;
 

tests/HeapHelperTest.php

@@ -1,13 +1,13 @@
 <?php
 
-use Mquinn\HeapHelper\HeapConfiguration;
-use Mquinn\HeapHelper\HeapHelper;
-use Mquinn\HeapHelper\Resources\HeapAccount;
-use Mquinn\HeapHelper\Resources\HeapAccounts;
-use Mquinn\HeapHelper\Resources\HeapEvent;
-use Mquinn\HeapHelper\Resources\HeapEvents;
-use Mquinn\HeapHelper\Resources\HeapUser;
-use Mquinn\HeapHelper\Resources\HeapUsers;
+use Mitquinn\HeapHelper\HeapConfiguration;
+use Mitquinn\HeapHelper\HeapHelper;
+use Mitquinn\HeapHelper\Resources\HeapAccount;
+use Mitquinn\HeapHelper\Resources\HeapAccounts;
+use Mitquinn\HeapHelper\Resources\HeapEvent;
+use Mitquinn\HeapHelper\Resources\HeapEvents;
+use Mitquinn\HeapHelper\Resources\HeapUser;
+use Mitquinn\HeapHelper\Resources\HeapUsers;
 use PHPUnit\Framework\TestCase;
 use Psr\Http\Client\ClientExceptionInterface;
 
@@ -34,7 +34,7 @@ protected function setUp(): void
         $apiKey = $_SERVER['HEAP_API_KEY'];
 
         $heapConfiguration = new HeapConfiguration($apiKey, $appId);
-        $heapHelper = new Mquinn\HeapHelper\HeapHelper($heapConfiguration);
+        $heapHelper = new Mitquinn\HeapHelper\HeapHelper($heapConfiguration);
         $this->setHeapHelper($heapHelper);
     }