diff options
| author | Robin Krahl <robin.krahl@ireas.org> | 2020-09-03 17:37:17 +0200 |
|---|---|---|
| committer | Daniel Mueller <deso@posteo.net> | 2020-09-04 07:48:57 -0700 |
| commit | a15c586b12e2e281184683686b6417b78de26a19 (patch) | |
| tree | 1954c62ab92f358502dd502d6ea6a9660ad9caf5 | |
| parent | 888c30e975726260e0af9b61baee6b17c51a06d5 (diff) | |
| download | nitrocli-a15c586b12e2e281184683686b6417b78de26a19.tar.gz nitrocli-a15c586b12e2e281184683686b6417b78de26a19.tar.bz2 | |
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.
| -rw-r--r-- | README.md | 8 |
1 files changed, 8 insertions, 0 deletions
@@ -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 |