summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJustin Wernick <justin@worthe-it.co.za>2023-06-04 20:54:37 +0200
committerJustin Wernick <justin@worthe-it.co.za>2023-06-04 20:55:54 +0200
commit513e490fe76166e006871ba6b6eedba061895738 (patch)
treee0c98659dea58d0a6a4cb24510d024c4af1ab7b1 /README.md
parent392a31cdab57c85f043831fd0814c8a45c73fab9 (diff)
Add Codeberg CI badge
Fix #5
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 6 insertions, 8 deletions
diff --git a/README.md b/README.md
index 882c63f..836a601 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,6 @@
-South African ID Number Parser
-==============================
+# South African ID Number Parser
+
+[![status-badge](https://ci.codeberg.org/api/badges/worthe-it/south-african-id-parser/status.svg)](https://ci.codeberg.org/worthe-it/south-african-id-parser)
The ID Numbers issued in South Africa follow a regular format that you
can use to derive some information about them. The following
@@ -16,8 +17,7 @@ More information on the ID number format can be found
[here](https://web.archive.org/web/20200101101847/http://geekswithblogs.net/willemf/archive/2005/10/30/58561.aspx)
and [here](http://knowles.co.za/generating-south-african-id-numbers/).
-Usage
------
+## Usage
Download the library from NPM using the following command in a terminal:
@@ -139,15 +139,13 @@ var isSouthAfricanCitizen = saIdParser.parseIsSouthAfricanCitizen(validIdNumber)
//isSouthAfricanCitizen === true
```
-Support
--------
+## Support
If you get value from this project, consider supporting me on
[Patreon](https://www.patreon.com/worthe_it). Support via Patreon will allow me
to spend more time writing and publishing open source software.
-License
--------
+## License
Copyright 2017-present, Justin Wernick