From cb35325c16760721e55783c4624ee63daa973f7c Mon Sep 17 00:00:00 2001
From: Justin Wernick <justin@worthe-it.co.za>
Date: Fri, 9 Jun 2023 13:49:21 +0200
Subject: Update JSDoc to include a readme

---
 .jsdocrc.json | 12 ++++++++++++
 README.md     |  8 +++++---
 package.json  |  2 +-
 3 files changed, 18 insertions(+), 4 deletions(-)
 create mode 100644 .jsdocrc.json

diff --git a/.jsdocrc.json b/.jsdocrc.json
new file mode 100644
index 0000000..99d9401
--- /dev/null
+++ b/.jsdocrc.json
@@ -0,0 +1,12 @@
+{
+  "source": {
+    "include": "./",
+    "includePattern": ".js$"
+  },
+  "plugins": ["plugins/markdown"],
+  "opts": {
+    "recurse": false,
+    "destination": "./dist/docs/",
+    "readme": "./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
 
diff --git a/package.json b/package.json
index bc15702..b66f554 100644
--- a/package.json
+++ b/package.json
@@ -6,7 +6,7 @@
   "scripts": {
     "pretest": "eslint ./",
     "test": "mocha",
-    "docs": "jsdoc *.js --destination dist/docs"
+    "docs": "jsdoc --configure .jsdocrc.json"
   },
   "keywords": [
     "South Africa",
-- 
cgit v1.2.3