From b115554301161fa21467629f1e1391c1936de517 Mon Sep 17 00:00:00 2001 From: Eduardo Gulias Davis Date: Fri, 27 Dec 2024 01:36:43 +0100 Subject: [PATCH] Fix Readme style --- README.md | 46 +++++++++++++++++++++++++++------------------- 1 file changed, 27 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index efadf0b..1d61f60 100644 --- a/README.md +++ b/README.md @@ -29,9 +29,13 @@ This library aims to support RFCs: ## Requirements - * PHP 8.1 - * [Composer](https://getcomposer.org) is required for installation - * [Spoofchecking](/src/Validation/Extra/SpoofCheckValidation.php) and [DNSCheckValidation](/src/Validation/DNSCheckValidation.php) validation requires that your PHP system has the [PHP Internationalization Libraries](https://php.net/manual/en/book.intl.php) (also known as PHP Intl) +* PHP 8.1 +* [Composer](https://getcomposer.org) is required for installation +* [Spoofchecking](/src/Validation/Extra/SpoofCheckValidation.php) and +[DNSCheckValidation](/src/Validation/DNSCheckValidation.php) validation +requires that your PHP system has the +[PHP Internationalization Libraries](https://php.net/manual/en/book.intl.php) +(also known as PHP Intl) **Note**: `PHP version upgrades will happen to accomodate to the pace of major frameworks. Minor versions bumps will go via minor versions of this library @@ -49,10 +53,11 @@ composer require egulias/email-validator ## Getting Started `EmailValidator` requires you to decide which (or combination of them) -validation/s strategy/ies you'd like to follow for each +validation/s strategy/ies you'd like to follow for each [validation](#available-validations). A basic example with the RFC validation + ```php isValid("example@example.com", new RFCValidation()); //true ``` - ### Available validations 1. [RFCValidation](/src/Validation/RFCValidation.php): Standard RFC-like email validation. -2. [NoRFCWarningsValidation](/src/Validation/NoRFCWarningsValidation.php): +2. [NoRFCWarningsValidation](/src/Validation/NoRFCWarningsValidation.php): RFC-like validation that will fail when warnings* are found. -3. [DNSCheckValidation](/src/Validation/DNSCheckValidation.php): +3. [DNSCheckValidation](/src/Validation/DNSCheckValidation.php): Will check if there are DNS records that signal that the server accepts emails. This does not entail that the email exists. -4. [MultipleValidationWithAnd](/src/Validation/MultipleValidationWithAnd.php): +4. [MultipleValidationWithAnd](/src/Validation/MultipleValidationWithAnd.php): It is a validation that operates over other validations performing a logical and (&&) over the result of each validation. -5. [MessageIDValidation](/src/Validation/MessageIDValidation.php): +5. [MessageIDValidation](/src/Validation/MessageIDValidation.php): Follows [RFC2822 for message-id](https://tools.ietf.org/html/rfc2822#section-3.6.4) to validate that field, that has some differences in the domain part. -6. [Your own validation](#how-to-extend): You can extend the library behaviour +6. [Your own validation](#how-to-extend): You can extend the library behaviour by implementing your own validations. -*warnings: Warnings are deviations from the RFC that in a broader interpretation +*warnings: Warnings are deviations from the RFC that in a broader interpretation are accepted. ```php @@ -100,7 +104,7 @@ $validator->isValid("example@ietf.org", $multipleValidations); //true #### Additional validations -Validations not present in the RFCs +Validations not present in the RFCs 1. [SpoofCheckValidation](/src/Validation/Extra/SpoofCheckValidation.php): Will check for multi-utf-8 chars that can signal an erroneous email name. @@ -108,25 +112,29 @@ Will check for multi-utf-8 chars that can signal an erroneous email name. ### How to extend -It's easy! You just need to implement [EmailValidation](/src/Validation/EmailValidation.php) and you can use your own validation. +It's easy! You just need to implement +[EmailValidation](/src/Validation/EmailValidation.php) and you can use your own +validation. ## Contributing -Please follow the [Contribution guide](CONTRIBUTING.md). Is short and simple and will help a lot. +Please follow the [Contribution guide](CONTRIBUTING.md). +Is short and simple and will help a lot. ## Other Contributors -(You can find current contributors [here](https://github.com/egulias/EmailValidator/graphs/contributors)) +(You can find current contributors +[here](https://github.com/egulias/EmailValidator/graphs/contributors)) As this is a port from another library and work, here are other people related to the previous one: -* Ricard Clau [@ricardclau](https://github.com/ricardclau): +* Ricard Clau [@ricardclau](https://github.com/ricardclau): Performance against PHP built-in filter_var (v2 and earlier) -* Josepf Bielawski [@stloyd](https://github.com/stloyd): +* Josepf Bielawski [@stloyd](https://github.com/stloyd): For its first re-work of Dominic's lib -* Dominic Sayers [@dominicsayers](https://github.com/dominicsayers): +* Dominic Sayers [@dominicsayers](https://github.com/dominicsayers): The original `isemail` function ## License -Released under the MIT License attached with this code. +Released under the MIT License attached with this code. \ No newline at end of file