chore: documentation improvements

Author: andrepimpao

README.md

@@ -1,6 +1,10 @@
 # Yet Another PHP Validator
 
-Versatile library focused on validating development code with expressive error messages.
+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.
 
 ## Requirements
 
@@ -44,6 +48,14 @@ $validator->assert(16, 'Age'); // throws exception: The "Age" value should be gr
 
 ## Documentation
 
+- [Get Started](docs/01-get-started.md)
+- [Usage](docs/02-usage.md)
+  - [Usage](docs/02-usage.md#usage)
+  - [Methods](docs/02-usage.md#methods)
+  - [Error Handling](docs/02-usage.md#error-handling)
+  - [Custom Error Messages](docs/02-usage.md#custom-error-messages)
+- [Rules](docs/03-rules.md)
+- [Custom Rules](docs/04-custom-rules.md)
 
 ## Contributing
 
@@ -52,7 +64,7 @@ Make sure to open a pull request or issue.
 
 ## Acknowledgments
 
-This library is inspired by [Respect's Validation](https://github.com/Respect/Validation) and [Symfony's Validator](https://symfony.com/doc/current/validation.html).
+This library is inspired by [respect/validation](https://github.com/Respect/Validation) and [symfony/validator](https://symfony.com/doc/current/validation.html).
 
 ## License
 

composer.json

@@ -1,6 +1,6 @@
 {
     "name": "programmatordev/yet-another-php-validator",
-    "description": "PHP Validator",
+    "description": "Versatile validator focused on validating development code with expressive error messages.",
     "type": "library",
     "keywords": ["PHP", "Validator", "Validation"],
     "license": "MIT",

docs/01-get-started.md

@@ -33,18 +33,13 @@ use ProgrammatorDev\YetAnotherPhpValidator\Validator;
 // Do this...
 $validator = Validator::notBlank()->greaterThanOrEqual(18);
 
-// ...or this...
+// Or this...
 $validator = new Validator(
     new Rule\NotBlank(), 
     new Rule\GreaterThanOrEqual(18)
 );
 
-// ...or even this...
-$validator = (new Validator())
-    ->addRule(new Rule\NotBlank())
-    ->addRule(new Rule\GreaterThanOrEqual(18));
-
-// ...and validate with these:
+// Validate with these:
 $validator->validate(16); // returns bool: false
 $validator->assert(16, 'Age'); // throws exception: The "Age" value should be greater than or equal to "18", "16" given.
 ```

docs/04-custom-rules.md

@@ -88,8 +88,6 @@ 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
-class FavoriteException extends ValidationException {}
-
 class Favorite extends AbstractRule implements RuleInterface
 {
     public function __construct(
@@ -105,7 +103,7 @@ class Favorite extends AbstractRule implements RuleInterface
                     'name' => $name,
                     'favorite' => $this->favorite,
                     'value' => $value
-                ]               
+                ]
             )
         }
     }