Skip to content

Commit

Permalink
readme updates
Browse files Browse the repository at this point in the history
  • Loading branch information
makowskid committed Dec 1, 2023
1 parent 955c601 commit a035b48
Showing 1 changed file with 13 additions and 5 deletions.
18 changes: 13 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# sg-nric
# sg-nric: PHP Singapore NRIC/FIN validator

PHP Singapore NRIC (National Registration Identity Card) or FIN (Foreign Identification Number) validator package

Expand All @@ -17,14 +17,22 @@ composer require makowskid/sg-nric
## Usage

```bash
$validator = new \Makowskid\SgNric\SgNric();

if($validator->isNricValid($theNric)) ..
use Makowskid\SgNric\SgNric;

//or
$validator = new SgNric();

if($validatator->isFinValid($theNric)) ..
if ($validator->isNricValid($theNric)) {
// NRIC is valid
// Your code here...
}

// OR

if ($validator->isFinValid($theFin)) {
// FIN is valid
// Your code here...
}

```
Expand Down

0 comments on commit a035b48

Please sign in to comment.