summaryrefslogtreecommitdiff
path: root/CHANGELOG.md
diff options
context:
space:
mode:
Diffstat (limited to 'CHANGELOG.md')
-rw-r--r--CHANGELOG.md34
1 files changed, 34 insertions, 0 deletions
diff --git a/CHANGELOG.md b/CHANGELOG.md
new file mode 100644
index 0000000..07e1066
--- /dev/null
+++ b/CHANGELOG.md
@@ -0,0 +1,34 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+This changelog focusses on changes which affect production users of this
+library. It will not mention any changes to code structure, internal design
+details, documentation, or testing unless they have some affect on the public
+API.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Added
+
+- 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.
+
+### Changed
+
+- Code hosting has been moved to
+ [Codeberg](https://codeberg.org/worthe-it/south-african-id-parser). Please use
+ Codeberg's issue tracker for issue reporting.
+
+## [1.0.0] - 2017-06-24
+
+### Added
+
+- South African ID number parsing and validation.
+
+[unreleased]: https://codeberg.org/worthe-it/south-african-id-parser/compare/v1.0.0...HEAD
+[1.0.0]: https://codeberg.org/worthe-it/south-african-id-parser/releases/tag/v1.0.0