From 196b94b90d894315322b8960acbf63fbde4b517f Mon Sep 17 00:00:00 2001
From: Kai Jan Kriegel <kai@kjkriegel.de>
Date: Thu, 6 Jan 2022 17:14:17 +0100
Subject: [PATCH] added a basic description of the crate

---
 Cargo.toml   | 6 ++++--
 src/lib.rs   | 7 +++++++
 tests/lib.rs | 7 -------
 3 files changed, 11 insertions(+), 9 deletions(-)
 delete mode 100644 tests/lib.rs

diff --git a/Cargo.toml b/Cargo.toml
index 22a34a3..0c3238f 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -1,11 +1,13 @@
 [package]
-name = "nfc"
+name = "desfire"
 version = "0.1.0"
 authors = ["Kai Jan Kriegel <kai@kjkriegel.de>"]
 edition = "2018"
 license = "MIT OR Apache-2.0"
+description = "Library for interfacing with Mifare Desfire cards."
+repository = "https://gitlab.com/fabinfra/fabaccess/nfc_rs"
 
-# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+#See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
 des = "0.7.0"
diff --git a/src/lib.rs b/src/lib.rs
index 417c505..06fd3a7 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -25,3 +25,10 @@ pub trait Card {
     /// <returns>Application Protocol Data Unit Response - ISO 7816</returns>
     fn transmit(&self, apdu_cmd: APDUCommand) -> Result<APDUResponse>;
 }
+
+//! # desfire
+//!
+//! The `desfire` Crate provides the cryptographic methods and specific commands for interfacing
+//! with NXP MiFare Desfire cards. 
+//!
+//! **WARNING** This is alpha quality Software at best and should not be relied upon.
diff --git a/tests/lib.rs b/tests/lib.rs
deleted file mode 100644
index 31e1bb2..0000000
--- a/tests/lib.rs
+++ /dev/null
@@ -1,7 +0,0 @@
-#[cfg(test)]
-mod tests {
-    #[test]
-    fn it_works() {
-        assert_eq!(2 + 2, 4);
-    }
-}