From 3a82bdc722a58b5eb4eaa6ec80a77bd3b6fd1d38 Mon Sep 17 00:00:00 2001 From: Robin Krahl Date: Tue, 1 Jan 2019 11:22:00 +0100 Subject: 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. --- README.md | 19 ++++++++++--------- 1 file changed, 10 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 9b4f654..94cbc1e 100644 --- a/README.md +++ b/README.md @@ -3,17 +3,18 @@ Low-level Rust bindings for `libnitrokey`, providing access to Nitrokey devices. -```toml -[dependencies] -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) -- `libhidapi-libusb0` +## Versioning + +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 +increased independently. ## Contact -- cgit v1.2.3