chore: misc documentation improvements

Author: andrepimpao

README.md

@@ -3,8 +3,8 @@
 Versatile validator focused on validating development code with expressive error messages.
 
 > **Note**
-> This library is not in version 1.x mainly because there are so few available rules.
-> Hopefully, that should change in the near future.
+> This library is not in version 1.x mainly because there are few available rules.
+> Hopefully, that will change in the near future.
 
 ## Requirements
 
@@ -59,7 +59,7 @@ $validator->assert(16, 'Age'); // throws exception: The "Age" value should be gr
 
 ## Contributing
 
-Any form of contribution to improve this library will be welcome and appreciated.
+Any form of contribution to improve this library (including requests) will be welcome and appreciated.
 Make sure to open a pull request or issue.
 
 ## Acknowledgments

docs/02-usage.md

@@ -187,9 +187,9 @@ function calculateDiscount(float $price, float $discount, string $type): float
 
 ## Error Handling
 
-When using the [`assert`](#assert) method to validate a value, an exception is thrown when a rule fails.
+When using the [`assert`](#assert) method, an exception is thrown when a rule fails.
 
-Each rule has a unique exception, formed by the name of the rule followed by the work Exception — `RuleNameException`.
+Each rule has a unique exception, formed by the name of the rule followed by the word Exception, like `RuleNameException`.
 The following shows an example:
 
 ```php
@@ -225,10 +225,12 @@ try {
 }
 catch (ValidationException $exception) {
     // Do something when a rule fails
+    echo $exception->getMessage();
 }
 ```
 
-When using both the [`assert`](#assert) or [`validate`](#validate) methods, an `UnexpectedValueException` is thrown when the provided input data is not valid to perform the validation. 
+When using both the [`assert`](#assert) or [`validate`](#validate) methods, 
+an `UnexpectedValueException` is thrown when the provided input data is not valid to perform the validation. 
 
 For example, when trying to compare a date with a string:
 
@@ -262,5 +264,5 @@ Validator::choice(
     message: '"{{ value }}" is not a valid {{ name }}! You must select one of {{ constraints }}.'
 )->assert('yellow', 'color');
 
-// "yellow" is not a valid color! You must select one of [red, green, blue].
+// Throws: "yellow" is not a valid color! You must select one of [red, green, blue].
 ```

docs/03x-rules-choice.md

@@ -51,7 +51,7 @@ Validator::choice(['red', 'green', 'blue'], multiple: true, minConstraint: 2, ma
 
 type: `array` `required`
 
-Collection of choices to be validated against the input value.
+Collection of constraint choices to be validated against the input value.
 
 ### `multiple`
 

docs/03x-rules-greater-than-or-equal.md

@@ -27,7 +27,7 @@ Validator::greaterThanOrEqual(new DateTime('today'))->validate(new DateTime('tod
 ```
 
 > **Note**
-> String comparison is case-sensitive, meaning that comparing `'hello'` with `'Hello'` is different.
+> String comparison is case-sensitive, meaning that comparing `"hello"` with `"Hello"` is different.
 > Check [`strcmp`](https://www.php.net/manual/en/function.strcmp.php) for more information.
 
 > **Note**

docs/03x-rules-greater-than.md

@@ -27,7 +27,7 @@ Validator::greaterThan(new DateTime('today'))->validate(new DateTime('today'));
 ```
 
 > **Note**
-> String comparison is case-sensitive, meaning that comparing `'hello'` with `'Hello'` is different. 
+> String comparison is case-sensitive, meaning that comparing `"hello"` with `"Hello"` is different.
 > Check [`strcmp`](https://www.php.net/manual/en/function.strcmp.php) for more information.
 
 > **Note**

docs/03x-rules-less-than-or-equal.md

@@ -27,7 +27,7 @@ Validator::lessThanOrEqual(new DateTime('today'))->validate(new DateTime('today'
 ```
 
 > **Note**
-> String comparison is case-sensitive, meaning that comparing `'hello'` with `'Hello'` is different.
+> String comparison is case-sensitive, meaning that comparing `"hello"` with `"Hello"` is different.
 > Check [`strcmp`](https://www.php.net/manual/en/function.strcmp.php) for more information.
 
 > **Note**

docs/03x-rules-less-than.md

@@ -27,7 +27,7 @@ Validator::lessThan(new DateTime('today'))->validate(new DateTime('today')); //
 ```
 
 > **Note**
-> String comparison is case-sensitive, meaning that comparing `'hello'` with `'Hello'` is different.
+> String comparison is case-sensitive, meaning that comparing `"hello"` with `"Hello"` is different.
 > Check [`strcmp`](https://www.php.net/manual/en/function.strcmp.php) for more information.
 
 > **Note**

docs/03x-rules-not-blank.md

@@ -11,8 +11,8 @@ NotBlank(
 
 ## Basic Usage
 
-Bellow are the only cases where the rule will fail, everything else is considered valid 
-(you may want to check the [`normalizer`](#normalizer) option for a different behaviour):
+Bellow are the only cases where the rule will fail, 
+everything else is considered valid (you may want to check the [`normalizer`](#normalizer) option for a different behaviour):
 
 ```php
 Validator::notBlank()->validate(''); // false
@@ -29,7 +29,7 @@ type: `callable` default: `null`
 
 Allows to define a `callable` that will be applied to the value before checking if it is valid.
 
-For example, use `trim`, or pass your own function, to now allow a string with whitespaces only:
+For example, use `trim`, or pass your own function, to not allow a string with whitespaces only:
 
 ```php
 // Existing PHP callables

docs/03x-rules-range.md

@@ -13,7 +13,7 @@ Range(
 
 ## Basic Usage
 
-Values equal to the defined minimum and maximum constraints are considered valid.
+Values equal to the defined minimum and maximum values are considered valid.
 
 ```php
 Validator::range(1, 20)->validate(10); // true
@@ -30,7 +30,7 @@ Validator::range(new DateTime('yesterday'), new DateTime('tomorrow'))->validate(
 ```
 
 > **Note**
-> String comparison is case-sensitive, meaning that comparing `'hello'` with `'Hello'` is different.
+> String comparison is case-sensitive, meaning that comparing `"hello"` with `"Hello"` is different.
 > Check [`strcmp`](https://www.php.net/manual/en/function.strcmp.php) for more information.
 
 > **Note**
@@ -60,7 +60,6 @@ Can be a `string`, `int`, `float` or `DateTimeInterface` object.
 type: `string` default: `The "{{ name }}" value should be between "{{ minConstraint }}" and "{{ maxConstraint }}", "{{ value }}" given.`
 
 Message that will be shown if the value is not between the minimum and maximum constraint values.
-Check the [Custom Messages]() section for more information.
 
 The following parameters are available:
 

docs/04-custom-rules.md

@@ -22,7 +22,7 @@ class CustomRuleException extends ValidationException {}
 ...then create your custom rule class...
 
 ```php
-namespace My\Project\Rules;
+namespace My\Project\Rule;
 
 use ProgrammatorDev\YetAnotherPhpValidator\Rule\AbstractRule;
 use ProgrammatorDev\YetAnotherPhpValidator\Rule\RuleInterface;
@@ -88,6 +88,10 @@ This means that you can have dynamic content in your messages.
 To make it work, just pass an associative array with the name and value of your parameters, and they will be available in the message:
 
 ```php
+// Exception
+class FavoriteException extends ValidationException {}
+
+// Rule
 class Favorite extends AbstractRule implements RuleInterface
 {
     public function __construct(
@@ -100,9 +104,9 @@ class Favorite extends AbstractRule implements RuleInterface
             throw new FavoriteException(
                 message: 'My favorite {{ name }} is "{{ favorite }}", not "{{ value }}"!',
                 parameters: [
-                    'name' => $name,
-                    'favorite' => $this->favorite,
-                    'value' => $value
+                    'name' => $name, // {{ name }}
+                    'favorite' => $this->favorite, // {{ favorite }}
+                    'value' => $value // {{ value }}
                 ]
             )
         }