First API version

README.md

@@ -1,4 +1,23 @@
-esp-api-engine
-==============
+# Crazy Awesome ESP E-Ngine API Client
 
-E-Ngine ESP Api
+Connect to the E-Ngine ESP with the API Client.
+
+## Information ##
+ - [E-Ngine ESP](http://www.e-ngine.nl/)
+
+## Installation ##
+Preferred way of installing is though [Composer](http://getcomposer.org). Add the following line to you `require`
+
+    "cac/esp-api-engine": ">=v0.1"
+
+## API Configuration ##
+The Adapter uses the E-Ngine SOAP Webservice for communication. When creating the `EngineApi` class some configuration is needed
+
+ + `domain` - The domain where E-Ngine is availabe. (e.g. `newsletter.yourdomain.com`)
+ + `path` - Path to the SOAP entry point on the `domain`. (e.g. `/soap/server.live.php`)
+ + `customer` - Your E-Ngine customer name
+ + `user` - Your E-Ngine user name
+ + `password` - Your E-Ngine password
+
+## Todo ##
+The API Client doesn't have all calls implemented at the moment. To use the latest version download the development version.

composer.json

@@ -0,0 +1,31 @@
+{
+    "name": "cac/esp-api-engine",
+    "description": "Crazy Awesome E-Ngine API Client",
+    "keywords": ["Email Service Provider", "esp", "email", "e-ngine"],
+    "homepage": "http://www.crazyawesomecompany.com",
+    "license": "BSD-3-Clause",
+    "support": {
+        "issues": "https://github.com/CrazyAwesomeCompany/esp-api-engine/issues",
+        "source": "https://github.com/CrazyAwesomeCompany/esp-api-engine"
+    },
+    "autoload": {
+        "psr-0": {
+            "\\CAC\\Component\\ESP\\Api\\Engine": "lib/"
+        },
+        "classmap": [ "lib/" ]
+    },
+    "require": {
+        "psr/log": ">=1"
+    },
+    "suggest": {
+        "monolog/monolog": "Adds logging abilities"
+    },
+    "authors": [
+        {
+            "name": "Nick de Groot",
+            "email": "[email protected]",
+            "homepage": "http://www.crazyawesomecompany.com",
+            "role": "Developer"
+        }
+    ]
+}