summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJustin Wernick <justin@worthe-it.co.za>2023-06-07 21:32:24 +0200
committerJustin Wernick <justin@worthe-it.co.za>2023-06-07 21:33:09 +0200
commit68fafbf7a45d15a7a8798e3cfa6f32319fa98e7e (patch)
tree153ae56ea65eaa1eabfabd92add824e75c71cc02 /README.md
parent58eb33e194807c3007bace488344cd12df496ee9 (diff)
Added the project's roadmap to the readme file
Fix #2
Diffstat (limited to 'README.md')
-rw-r--r--README.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/README.md b/README.md
index adf21e5..47194fb 100644
--- a/README.md
+++ b/README.md
@@ -140,6 +140,27 @@ var isSouthAfricanCitizen = saIdParser.parseIsSouthAfricanCitizen(validIdNumber)
// isSouthAfricanCitizen === true
```
+## Reporting issues
+
+Please report any issues on the project's [issue
+tracker](https://codeberg.org/worthe-it/south-african-id-parser/issues).
+
+## Roadmap
+
+This library is considered to be feature complete, so there are no new planned
+features.
+
+This project is still actively maintained. Reported issues will be addressed,
+and dependencies will be kept up to date.
+
+## Releases
+
+See [CHANGELOG.md](./CHANGELOG.md) for release notes.
+
+Releases are also available on
+[NPM](https://www.npmjs.com/package/south-african-id-parser) and
+[Codeberg](https://codeberg.org/worthe-it/south-african-id-parser/releases).
+
## Support
If you get value from this project, consider supporting me on