Skip to content

Commit

Permalink
Add disclaimer
Browse files Browse the repository at this point in the history
  • Loading branch information
boolproof committed Apr 1, 2022
1 parent 1e50e59 commit 802b1ce
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@
# PESEL number validator
Package provides validation of PESEL (the national identification number used in Poland - https://en.wikipedia.org/wiki/PESEL) for **Go**. If argument PESEL number (passed in as a `string`) is valid, result struct provides access to birthdate and gender extracted from the number, while result error is `nil`. If number is invalid, non `nil` error is returned, while the result struct contains zero values.

## Disclaimer
This package is not providing information if given PESEL number exists. Package only validates if the number complies with basic rules described by legislation. Positive validation doesn't mean given number has been issued and assigned to any person. Negative validation means that the number theoretically could have not been issued, unless by mistake of authorities.

## Example usage

```go
Expand Down

0 comments on commit 802b1ce

Please sign in to comment.