summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJustin Wernick <justin@worthe-it.co.za>2023-06-09 13:49:21 +0200
committerJustin Wernick <justin@worthe-it.co.za>2023-06-09 13:49:21 +0200
commitcb35325c16760721e55783c4624ee63daa973f7c (patch)
tree86b93ef1af032737a097ce2acdf4c10fa77f9091 /README.md
parentc3557a37cc9e4d23db0f14f669e72c7aaff5d4c1 (diff)
Update JSDoc to include a readme
Diffstat (limited to 'README.md')
-rw-r--r--README.md8
1 files changed, 5 insertions, 3 deletions
diff --git a/README.md b/README.md
index 9751463..2efa08e 100644
--- a/README.md
+++ b/README.md
@@ -142,7 +142,8 @@ var isSouthAfricanCitizen = saIdParser.parseIsSouthAfricanCitizen(validIdNumber)
## Releases
-See [CHANGELOG.md](./CHANGELOG.md) for release notes.
+See [CHANGELOG.md](https://codeberg.org/worthe-it/south-african-id-parser/src/branch/main/CHANGELOG.md)
+for release notes.
Releases are also available on
[NPM](https://www.npmjs.com/package/south-african-id-parser) and
@@ -163,8 +164,9 @@ and dependencies will be kept up to date.
## Contributing
-See [CONTRIBUTING.md](./CONTRIBUTING.md) for instructions on setting up a
-development environment to make changes and submit contributions.
+See [CONTRIBUTING.md](https://codeberg.org/worthe-it/south-african-id-parser/src/branch/main/CONTRIBUTING.md)
+for instructions on setting up a development environment to make changes and
+submit contributions.
## Support