From cb35325c16760721e55783c4624ee63daa973f7c Mon Sep 17 00:00:00 2001 From: Justin Wernick Date: Fri, 9 Jun 2023 13:49:21 +0200 Subject: Update JSDoc to include a readme --- README.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) (limited to 'README.md') 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 -- cgit v1.2.3