diff options
| author | Robin Krahl <robin.krahl@ireas.org> | 2018-05-20 11:01:49 +0200 |
|---|---|---|
| committer | Robin Krahl <robin.krahl@ireas.org> | 2018-05-20 11:01:49 +0200 |
| commit | 00bca17a32e8d14085b5ee417421b88a4d3d9e3b (patch) | |
| tree | 878d748094e82e0f2cabee846fcf0471d9cbb9c7 | |
| parent | 0c19419840eb91feec306e96bcb258da83e8aeea (diff) | |
| download | nitrokey-sys-rs-00bca17a32e8d14085b5ee417421b88a4d3d9e3b.tar.gz nitrokey-sys-rs-00bca17a32e8d14085b5ee417421b88a4d3d9e3b.tar.bz2 | |
Add readme
| -rw-r--r-- | Cargo.toml | 1 | ||||
| -rw-r--r-- | README.md | 25 |
2 files changed, 26 insertions, 0 deletions
@@ -9,6 +9,7 @@ categories = ["external-ffi-bindings"] license = "LGPL-3.0" links = "nitrokey" build = "build.rs" +readme = "README.md" [dependencies] libc = "0.2" diff --git a/README.md b/README.md new file mode 100644 index 0000000..758b558 --- /dev/null +++ b/README.md @@ -0,0 +1,25 @@ +# nitrokey-sys-rs + +Low-level Rust bindings for `libnitrokey`, providing access to Nitrokey +devices. + +```toml +[dependencies] +nitrokey-sys = "0.1.0" +``` + +Currently, this crate requires a `libnitrokey` installation available in the +default library and include path. + +## 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 |