Update README

This commit is contained in:
ErickSkrauch 2017-10-01 01:51:45 +03:00
parent e2ae355a60
commit 92d74e3369
No known key found for this signature in database
GPG Key ID: 669339FCBB30EE0E
1 changed files with 4 additions and 20 deletions

View File

@ -4,16 +4,15 @@
[![Software License][ico-license]](LICENSE.md)
[![Total Downloads][ico-downloads]][link-downloads]
Yii2 validator, based on [https://github.com/elyby/php-tempmailbuster](https://github.com/elyby/php-tempmailbuster)
library and [https://github.com/elyby/anti-tempmail-repo](https://github.com/elyby/anti-tempmail-repo) reference.
Helps to protect you site from users, who use 10-minutes mail services.
Yii2 validator, based on [daveearley/Email-Validation-Tool](https://github.com/daveearley/Email-Validation-Tool)
to protect your site from users, who use 10-minutes mail services.
## Installation
Install the latest version with
```sh
$ composer require "ely/yii2-tempmail-validator:~1.0.0"
$ composer require ely/yii2-tempmail-validator
```
## Usage
@ -24,22 +23,7 @@ Once the extension is installed, simply use it in your models:
public function rules()
{
return [
[['email'], \Ely\Yii2\TempmailValidator::className()],
];
}
```
Also you can configure validator:
```php
public function rules()
{
return [
[['email'], \Ely\Yii2\TempmailValidator::className(),
'message' => '{attribute} is tempmail. You will not pass',
'whiteList' => false,
'secondaryStorage' => ['spam4\.me'],
],
[['email'], \Ely\Yii2\TempmailValidator::class],
];
}
```