diff options
author | Robin Krahl <robin.krahl@ireas.org> | 2019-01-01 11:22:00 +0100 |
---|---|---|
committer | Robin Krahl <robin.krahl@ireas.org> | 2019-01-01 11:22:00 +0100 |
commit | 3a82bdc722a58b5eb4eaa6ec80a77bd3b6fd1d38 (patch) | |
tree | 50566b7242f168b0d4a2981a2601a8c432cf5303 | |
parent | a47058981611bacae464ed6deac39c6686357f3a (diff) | |
download | nitrokey-sys-rs-3a82bdc722a58b5eb4eaa6ec80a77bd3b6fd1d38.tar.gz nitrokey-sys-rs-3a82bdc722a58b5eb4eaa6ec80a77bd3b6fd1d38.tar.bz2 |
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.
-rw-r--r-- | README.md | 19 |
1 files changed, 10 insertions, 9 deletions
@@ -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 |