diff options
| -rw-r--r-- | CHANGELOG.md | 1 | ||||
| -rw-r--r-- | README.md | 8 |
2 files changed, 9 insertions, 0 deletions
diff --git a/CHANGELOG.md b/CHANGELOG.md index aeff1be..f5b6c93 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -20,6 +20,7 @@ Unreleased set the defaults for the `--model` and `--verbose` options - Changed the handling of the `NITROCLI_NO_CACHE` variable to check the value of the variable instead of only the presence +- Declared public API to be the man page - Adjusted license & copyright headers to comply with REUSE 3.0 - Added CI stage checking compliance - Updated minimum required Rust version to `1.42.0` @@ -141,6 +141,13 @@ Known Problems running shortly afterwards ([upstream issue][libnitrokey#137]). +Public API and Stability +------------------------ + +**nitrocli** follows the [Semantic Versioning specification 2.0.0][semver]. +Its public API is defined by the [nitrocli(1) `man` page](doc/nitrocli.1.pdf). + + Contributing ------------ @@ -182,3 +189,4 @@ the full text of the license. [libnitrokey#32]: https://github.com/Nitrokey/libnitrokey/issues/32 [libnitrokey#137]: https://github.com/Nitrokey/libnitrokey/issues/137 [reuse]: https://reuse.software/practices/3.0/ +[semver]: https://semver.org |