From b2dd7519f5182d9e969c2ec47abddc9a2b0c5a0f Mon Sep 17 00:00:00 2001 From: Tobias Dierich Date: Sun, 9 Feb 2020 23:25:38 +0100 Subject: [PATCH] Update README.md --- README.md | 41 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 41 insertions(+) diff --git a/README.md b/README.md index 56187be..3474c0c 100644 --- a/README.md +++ b/README.md @@ -1 +1,42 @@ # Validate the format of EU VAT identification numbers + +[![Latest Version on Packagist](https://img.shields.io/packagist/v/codelayer/laravel-vat-validator.svg?style=flat-square)](https://packagist.org/packages/codelayer/laravel-vat-validator) + +This package can be used to validate EU VAT identification numbers such as `DE123456789`. + +You can install the package using composer: + +```bash +composer require codelayer/laravel-vat-validator +``` + +### Translations + +If you wish to customize the package's translation, you can publish the translation files: + +```bash +php artisan vendor:publish --provider="Codelayer\VatValidator\VatValidatorServiceProvider" +``` + +## Usage + +Simply use the `VatFormat` rule inside your rules array, e.g. in a form request: + +```php +use Codelayer\VatValidator\Rules\VatFormat; + +public function rules() +{ + return [ + 'vat_number' => ['required', new VatFormat()], + ]; +} +``` + +## About Us + +[codelayer](https://codelayer.de) is a web development agency based in Karlsruhe, Germany. This package was developed for use in our product [likvi](https://likvi.de). + +## License + +The MIT License (MIT).