From 057fb89b3e99f2b9bef5d3055d362c80352a2661 Mon Sep 17 00:00:00 2001 From: Robin Krahl Date: Thu, 3 Sep 2020 17:37:17 +0200 Subject: Declare semver compatibility and public API This patch adds a new section to the README that declares that we follow the Semantic Versioning specification and that the public API of our crate is defined by the man page. --- CHANGELOG.md | 1 + README.md | 8 ++++++++ 2 files changed, 9 insertions(+) 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` diff --git a/README.md b/README.md index f1b4656..e6500f0 100644 --- a/README.md +++ b/README.md @@ -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 -- cgit v1.2.3