From 733d151700b20c4e03109e95073780c8f2f522d8 Mon Sep 17 00:00:00 2001 From: corydavis Date: Wed, 29 May 2024 17:02:51 +0000 Subject: [PATCH] docs: Update README --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 1e043fb..4824a59 100644 --- a/README.md +++ b/README.md @@ -345,7 +345,7 @@ The `cvv` validation by default tests for a numeric string of 3 characters in le #### `valid.postalCode(value: string, [options: object]): object` -The `postalCode` validation essentially tests for a valid string greater than 3 characters in length. +The `postalCode` validation essentially ignores leading whitespace and tests for a valid string greater than 3 characters in length. It also verifies that the first 3 letters are alphanumeric. ```javascript { @@ -354,7 +354,7 @@ The `postalCode` validation essentially tests for a valid string greater than 3 } ``` -You can optionally pass `minLength` as a property of an object as a second argument. This will override the default min length of 3. +You can optionally pass `minLength` as a property of an object as a second argument. This will override the default min length of 3 and verify that the characters for the specified length are all alphanumeric. ```javascript valid.postalCode('123', {minLength: 5});