aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--Cargo.toml1
-rw-r--r--README.md25
2 files changed, 26 insertions, 0 deletions
diff --git a/Cargo.toml b/Cargo.toml
index 23c0142..acfc511 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -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