aboutsummaryrefslogtreecommitdiff
path: root/nitrokey-sys/README.md
diff options
context:
space:
mode:
authorRobin Krahl <me@robin-krahl.de>2018-12-11 23:50:45 +0100
committerDaniel Mueller <deso@posteo.net>2018-12-17 07:52:13 -0800
commit986ad2f782cf944990e4eda8bf88ea1821233302 (patch)
tree1717075a4eb11861c32e5c45d01e47360fb1264d /nitrokey-sys/README.md
parente97c287c01cf22a1b582a7da9b309b58f3935d0e (diff)
downloadnitrocli-986ad2f782cf944990e4eda8bf88ea1821233302.tar.gz
nitrocli-986ad2f782cf944990e4eda8bf88ea1821233302.tar.bz2
Add nitrokey as a dependency to nitrocli
The nitrokey crate provides a simple interface to the Nitrokey Storage and the Nitrokey Pro based on the libnitrokey library developed by Nitrokey UG. The low-level bindings to this library are available in the nitrokey-sys crate. This patch adds version v0.2.1 of the nitrokey crate as a dependency for nitrocli. It includes the indirect dependencies nitrokey-sys (version 3.4.1) and rand (version 0.4.3). Import subrepo nitrokey/:nitrokey at 2eccc96ceec2282b868891befe9cda7f941fbe7b Import subrepo nitrokey-sys/:nitrokey-sys at f1a11ebf72610fb9cf80ac7f9f147b4ba1a5336f Import subrepo rand/:rand at d7d5da49daf7ceb3e5940072940d495cced3a1b3
Diffstat (limited to 'nitrokey-sys/README.md')
-rw-r--r--nitrokey-sys/README.md29
1 files changed, 29 insertions, 0 deletions
diff --git a/nitrokey-sys/README.md b/nitrokey-sys/README.md
new file mode 100644
index 0000000..9b4f654
--- /dev/null
+++ b/nitrokey-sys/README.md
@@ -0,0 +1,29 @@
+# nitrokey-sys-rs
+
+Low-level Rust bindings for `libnitrokey`, providing access to Nitrokey
+devices.
+
+```toml
+[dependencies]
+nitrokey-sys = "3.4.1"
+```
+
+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`
+
+## Contact
+
+For bug reports, patches, feature requests or other messages, please send a
+mail to [nitrokey-rs-dev@ireas.org][].
+
+## License
+
+This project as well as `libnitrokey` are licensed under the [LGPL-3.0][].
+
+[`libnitrokey`]: https://github.com/nitrokey/libnitrokey
+[nitrokey-rs-dev@ireas.org]: mailto:nitrokey-rs-dev@ireas.org
+[LGPL-3.0]: https://opensource.org/licenses/lgpl-3.0.html