Merge branch 'master' of https://github.com/tigron/skeleton-vat-check

LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Tigron
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,2 +1,35 @@
 # skeleton-vat-check
-Check Vat number against various sources
+
+## Description
+
+Check Vat number in 4 steps:
+1. syntax via a predefined regex array (list available in config)
+2. is european
+3. caching table (prevent denial of VIES service)
+4. VIES service
+
+## Installation
+
+Installation via composer:
+
+    composer require tigron/skeleton-vat-check
+
+## Howto setup
+
+Run the initial migration or executed the following queries
+
+	CREATE TABLE `vat_check_cache` (
+  		`id` int(11) NOT NULL AUTO_INCREMENT,
+  		`vat_number` varchar(255) COLLATE utf8_unicode_ci NOT NULL,
+  		`country_id` int(11) NOT NULL,
+  		`valid` int(11) NOT NULL DEFAULT '0',
+  		`created` datetime NOT NULL,
+  		PRIMARY KEY (`id`)
+	) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_unicode_ci;
+
+	INSERT INTO `transaction` (`classname`, `created`, `scheduled_at`, `data`, `retry_attempt`, `recurring`, `completed`, `failed`, `locked`, `frozen`, `parallel`) 
+	VALUES ('Cleanup_Vat_Check_Cache', now(), now(), '', '', '1', '0', '0', '0', '0', '0');
+
+## Howto use
+
+Call \Skeleton\Vat\Check\Check::validate($vat_number, $country) to validate a given VAT number