|author||Robin Krahl <email@example.com>||2019-01-01 11:22:00 +0100|
|committer||Robin Krahl <firstname.lastname@example.org>||2019-01-01 11:22:00 +0100|
Update README to reflect versioning changes
To be able to ship crate updates without a new libnitrokey version, the patch version is decoupled from libnitrokey. This patch updates the README to describe this policy.
1 files changed, 10 insertions, 9 deletions
@@ -3,17 +3,18 @@
Low-level Rust bindings for `libnitrokey`, providing access to Nitrokey
-nitrokey-sys = "3.4.1"
+This crate contains a copy of the [`libnitrokey`] library, builds it from
+source and links it statically. The host system must provide its dependencies
+in the library search path:
-The version of this crate corresponds to the wrapped `libnitrokey` version.
-This crate contains a copy of the `libnitrokey` library, builds it from source
-and links it statically. The host system must provide its dependencies in the
-library search path:
+- `libhidapi-libusb0` (on Linux)
+- `libhidapi` (on non-Linux systems)
+The major and minor version of the `nitrokey-sys` crate map to the major and
+minor version of `libnitrokey`. The `nitrokey-sys` patch version may be