Merge pull request #2 from evertharmeling/develop

Added README
evertharmeling · Jun 11, 2017 · 6d3a109 · 6d3a109
2 parents eb82c6d + 0c5415d
commit 6d3a109
Show file tree

Hide file tree

Showing 8 changed files with 31 additions and 7 deletions.
diff --git a/README.md b/README.md
@@ -1,4 +1,28 @@
 VATClient
 ===================
 
+[![Latest Stable Version](https://img.shields.io/packagist/v/evertharmeling/vat-client.svg?style=flat-square)](https://packagist.org/packages/evertharmeling/vat-client)
 [![Build Status](https://travis-ci.org/evertharmeling/vat-client.png?branch=master)](https://travis-ci.org/evertharmeling/vat-client)
+
+This libray supports validating a vat number and getting the info about a taxable object. The library uses the `http://www.controleerbtwnummer.nl/` API to retrieve the info and validation. 
+The `http://www.controleerbtwnummer.nl/` API relies on the [VIES/EU](http://ec.europa.eu/taxation_customs/vies/?locale=en) service and thus supports VAT numbers from all EU-countries.
+
+## Installation
+
+`composer install evertharmeling/vat-client`
+
+## Usage
+
+It's required to use a PSR-7 supported HTTPClient like `guzzle` (^6.0) to inject in the `Client`.
+
+```php
+$client = new VIESApi\Client\Client(new GuzzleHttp\Client(), VIESApi\Parser\VATParser());
+
+try {
+    $taxableObject = $client->getInfo('<VATNumber>');
+
+    var_dump($taxableObject);
+catch (TaxableObjectNotFoundException $e) {
+    // VAT number not found
+}
+```
diff --git a/src/VIESApi/Client/Client.php b/src/VIESApi/Client/Client.php
@@ -11,7 +11,7 @@
 use VIESApi\Parser\VATParser;
 
 /**
- * @author Evert Harmeling <evert@freshheads.com>
+ * @author Evert Harmeling <evertharmeling@gmail.com>
  */
 class Client
 {

diff --git a/src/VIESApi/Exception/InvalidResponseException.php b/src/VIESApi/Exception/InvalidResponseException.php
@@ -3,7 +3,7 @@
 namespace VIESApi\Exception;
 
 /**
- * @author Evert Harmeling <evert@freshheads.com>
+ * @author Evert Harmeling <evertharmeling@gmail.com>
  */
 class InvalidResponseException extends \Exception implements VIESApiExceptionInterface
 {

diff --git a/src/VIESApi/Exception/TaxableObjectNotFoundException.php b/src/VIESApi/Exception/TaxableObjectNotFoundException.php
@@ -3,7 +3,7 @@
 namespace VIESApi\Exception;
 
 /**
- * @author Evert Harmeling <evert@freshheads.com>
+ * @author Evert Harmeling <evertharmeling@gmail.com>
  */
 class TaxableObjectNotFoundException extends \Exception implements VIESApiExceptionInterface
 {

diff --git a/src/VIESApi/Exception/VIESApiExceptionInterface.php b/src/VIESApi/Exception/VIESApiExceptionInterface.php
@@ -3,7 +3,7 @@
 namespace VIESApi\Exception;
 
 /**
- * @author Evert Harmeling <evert@freshheads.com>
+ * @author Evert Harmeling <evertharmeling@gmail.com>
  */
 interface VIESApiExceptionInterface
 {

diff --git a/src/VIESApi/Model/TaxableObject.php b/src/VIESApi/Model/TaxableObject.php
@@ -3,7 +3,7 @@
 namespace VIESApi\Model;
 
 /**
- * @author Evert Harmeling <evert@freshheads.com>
+ * @author Evert Harmeling <evertharmeling@gmail.com>
  */
 class TaxableObject
 {

diff --git a/src/VIESApi/Parser/VATParser.php b/src/VIESApi/Parser/VATParser.php
@@ -5,7 +5,7 @@
 use VIESApi\Model\TaxableObject;
 
 /**
- * @author Evert Harmeling <evert@freshheads.com>
+ * @author Evert Harmeling <evertharmeling@gmail.com>
  */
 class VATParser
 {

diff --git a/tests/VIESApi/Client/ClientTest.php b/tests/VIESApi/Client/ClientTest.php
@@ -8,7 +8,7 @@
 use VIESApi\Parser\VATParser;
 
 /**
- * @author Evert Harmeling <evert@freshheads.com>
+ * @author Evert Harmeling <evertharmeling@gmail.com>
  */
 class ClientTest extends \PHPUnit_Framework_TestCase
 {