Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
makowskid committed Aug 23, 2022
1 parent 7327b33 commit 0f4c907
Showing 1 changed file with 14 additions and 2 deletions.
16 changes: 14 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# sg-nric

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


[![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](LICENSE.md)
[![Total Downloads](https://img.shields.io/packagist/dt/makowskid/sg-nric.svg?style=flat-square)](https://packagist.org/packages/makowskid/sg-nric)
Expand All @@ -15,9 +16,20 @@ composer require makowskid/sg-nric

## Usage

Write a few lines about the usage of this package.
```bash
$validator = new \makowskid\SgNric\SgNricValidator();

if($validator->isNricValid($theNric)) ..

//or


if($validatator->isFinValid($theNric)) ..

// or use the defined `sg-nric` facade

```

## Testing

Run the tests with:
Expand Down

0 comments on commit 0f4c907

Please sign in to comment.