diff options
| author | Justin Wernick <justin@worthe-it.co.za> | 2023-06-13 14:32:06 +0200 |
|---|---|---|
| committer | Justin Wernick <justin@worthe-it.co.za> | 2023-06-13 14:32:06 +0200 |
| commit | 3caeb30fa21f94f5fbc5bea144d4c9e6908c3443 (patch) | |
| tree | 58a233d37a201ebd5a86981301572f6a37b731c0 | |
| parent | 7e71779fcbf7a00d61d82c0f6bafd288fa153636 (diff) | |
Mention the API docs in all the docs
| -rw-r--r-- | CHANGELOG.md | 2 | ||||
| -rw-r--r-- | README.md | 4 | ||||
| -rw-r--r-- | package.json | 2 |
3 files changed, 7 insertions, 1 deletions
diff --git a/CHANGELOG.md b/CHANGELOG.md index 07e1066..3e72322 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -17,6 +17,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - This changelog can now be used to track changes to the library's public API. - Dependencies are now checked for security vulnerabilities using `npm audit` before release. +- API docs are now available at + https://worthe-it.codeberg.page/south-african-id-parser/. ### Changed @@ -18,6 +18,10 @@ 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/). +## API Docs + +API docs are available [here](https://worthe-it.codeberg.page/south-african-id-parser/); + ## Usage Download the library from NPM using the following command in a terminal: diff --git a/package.json b/package.json index 1d5c33d..c0613e8 100644 --- a/package.json +++ b/package.json @@ -21,7 +21,7 @@ "type": "git", "url": "https://codeberg.org/worthe-it/south-african-id-parser.git" }, - "homepage": "https://codeberg.org/worthe-it/south-african-id-parser", + "homepage": "https://worthe-it.codeberg.page/south-african-id-parser/", "bugs": "https://codeberg.org/worthe-it/south-african-id-parser/issues", "license": "(ISC OR GPL-3.0)", "funding": { |