summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAsko Nomm <asko@bien.ee>2022-02-23 00:07:38 +0100
committerAsko Nomm <asko@bien.ee>2022-02-23 00:07:38 +0100
commit69cb6a7c96e1813bff708efd56e072a97f001095 (patch)
tree2abac5943e517ecd083fcc0a120f43856c40fcf3
parent70b9c1901e68fd4cec5f075cbc4e4b85b6ba57b0 (diff)
Doc fixes
-rw-r--r--README.md6
-rw-r--r--src/Bouncer.php9
2 files changed, 3 insertions, 12 deletions
diff --git a/README.md b/README.md
index 5353250..075f1c3 100644
--- a/README.md
+++ b/README.md
@@ -16,11 +16,7 @@ composer require askonomm/bouncer
## Usage
-The Bouncer takes in an array of fields, an array of rules and optionally an array of validators. If no validators are provided, default validators will be used instead, which are:
-
-- `\Askonomm\Bouncer\Validators\LenValidator`
-- `\Askonomm\Bouncer\Validators\EmailValidator`
-- `\Askonomm\Bouncer\Validators\RequiredValidator`
+The Bouncer takes in an array of `$fields` and an array of `$rules`.
The key of each item in the `$fields` array must correspond to the the key of each item in the `$rules` array, so that Bouncer would know how to connect the two to each other.
diff --git a/src/Bouncer.php b/src/Bouncer.php
index 0bfbdcb..517315b 100644
--- a/src/Bouncer.php
+++ b/src/Bouncer.php
@@ -10,13 +10,8 @@ use Askonomm\Bouncer\Validators\EmailValidator;
use Askonomm\Bouncer\Validators\RequiredValidator;
/**
- * The Bouncer takes in an array of fields, an array of
- * rules and optionally an array of validators. If no validators
- * are provided, default validators will be used instead, which are:
- *
- * - `\Askonomm\Bouncer\Validators\LenValidator`
- * - `\Askonomm\Bouncer\Validators\EmailValidator`
- * - `\Askonomm\Bouncer\Validators\RequiredValidator`
+ * The Bouncer takes in an array of `$fields` and an array of
+ * `$rules`.
*
* The key of each item in the `$fields` array must correspond to the
* the key of each item in the `$rules` array, so that Bouncer