Skip to content

Commit b115554

Browse files
committed
Fix Readme style
1 parent c67e8e6 commit b115554

File tree

1 file changed

+27
-19
lines changed

1 file changed

+27
-19
lines changed

README.md

Lines changed: 27 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,13 @@ This library aims to support RFCs:
2929

3030
## Requirements
3131

32-
* PHP 8.1
33-
* [Composer](https://getcomposer.org) is required for installation
34-
* [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)
32+
* PHP 8.1
33+
* [Composer](https://getcomposer.org) is required for installation
34+
* [Spoofchecking](/src/Validation/Extra/SpoofCheckValidation.php) and
35+
[DNSCheckValidation](/src/Validation/DNSCheckValidation.php) validation
36+
requires that your PHP system has the
37+
[PHP Internationalization Libraries](https://php.net/manual/en/book.intl.php)
38+
(also known as PHP Intl)
3539

3640
**Note**: `PHP version upgrades will happen to accomodate to the pace of major
3741
frameworks. Minor versions bumps will go via minor versions of this library
@@ -49,10 +53,11 @@ composer require egulias/email-validator
4953
## Getting Started
5054

5155
`EmailValidator` requires you to decide which (or combination of them)
52-
validation/s strategy/ies you'd like to follow for each
56+
validation/s strategy/ies you'd like to follow for each
5357
[validation](#available-validations).
5458

5559
A basic example with the RFC validation
60+
5661
```php
5762
<?php
5863

@@ -63,22 +68,21 @@ $validator = new EmailValidator();
6368
$validator->isValid("[email protected]", new RFCValidation()); //true
6469
```
6570

66-
6771
### Available validations
6872

6973
1. [RFCValidation](/src/Validation/RFCValidation.php): Standard RFC-like email validation.
70-
2. [NoRFCWarningsValidation](/src/Validation/NoRFCWarningsValidation.php):
74+
2. [NoRFCWarningsValidation](/src/Validation/NoRFCWarningsValidation.php):
7175
RFC-like validation that will fail when warnings* are found.
72-
3. [DNSCheckValidation](/src/Validation/DNSCheckValidation.php):
76+
3. [DNSCheckValidation](/src/Validation/DNSCheckValidation.php):
7377
Will check if there are DNS records that signal that the server accepts emails. This does not entail that the email exists.
74-
4. [MultipleValidationWithAnd](/src/Validation/MultipleValidationWithAnd.php):
78+
4. [MultipleValidationWithAnd](/src/Validation/MultipleValidationWithAnd.php):
7579
It is a validation that operates over other validations performing a logical and (&&) over the result of each validation.
76-
5. [MessageIDValidation](/src/Validation/MessageIDValidation.php):
80+
5. [MessageIDValidation](/src/Validation/MessageIDValidation.php):
7781
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.
78-
6. [Your own validation](#how-to-extend): You can extend the library behaviour
82+
6. [Your own validation](#how-to-extend): You can extend the library behaviour
7983
by implementing your own validations.
8084

81-
*warnings: Warnings are deviations from the RFC that in a broader interpretation
85+
*warnings: Warnings are deviations from the RFC that in a broader interpretation
8286
are accepted.
8387

8488
```php
@@ -100,33 +104,37 @@ $validator->isValid("[email protected]", $multipleValidations); //true
100104

101105
#### Additional validations
102106

103-
Validations not present in the RFCs
107+
Validations not present in the RFCs
104108

105109
1. [SpoofCheckValidation](/src/Validation/Extra/SpoofCheckValidation.php):
106110
Will check for multi-utf-8 chars that can signal an erroneous email name.
107111

108112

109113
### How to extend
110114

111-
It's easy! You just need to implement [EmailValidation](/src/Validation/EmailValidation.php) and you can use your own validation.
115+
It's easy! You just need to implement
116+
[EmailValidation](/src/Validation/EmailValidation.php) and you can use your own
117+
validation.
112118

113119
## Contributing
114120

115-
Please follow the [Contribution guide](CONTRIBUTING.md). Is short and simple and will help a lot.
121+
Please follow the [Contribution guide](CONTRIBUTING.md).
122+
Is short and simple and will help a lot.
116123

117124
## Other Contributors
118125

119-
(You can find current contributors [here](https://github.com/egulias/EmailValidator/graphs/contributors))
126+
(You can find current contributors
127+
[here](https://github.com/egulias/EmailValidator/graphs/contributors))
120128

121129
As this is a port from another library and work, here are other people related to the previous one:
122130

123-
* Ricard Clau [@ricardclau](https://github.com/ricardclau):
131+
* Ricard Clau [@ricardclau](https://github.com/ricardclau):
124132
Performance against PHP built-in filter_var (v2 and earlier)
125-
* Josepf Bielawski [@stloyd](https://github.com/stloyd):
133+
* Josepf Bielawski [@stloyd](https://github.com/stloyd):
126134
For its first re-work of Dominic's lib
127-
* Dominic Sayers [@dominicsayers](https://github.com/dominicsayers):
135+
* Dominic Sayers [@dominicsayers](https://github.com/dominicsayers):
128136
The original `isemail` function
129137

130138
## License
131139

132-
Released under the MIT License attached with this code.
140+
Released under the MIT License attached with this code.

0 commit comments

Comments
 (0)