added a basic description of the crate

This commit is contained in:
Kai Jan Kriegel 2022-01-06 17:14:17 +01:00
parent f0f0207221
commit 196b94b90d
3 changed files with 11 additions and 9 deletions

View File

@ -1,9 +1,11 @@
[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

View File

@ -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.

View File

@ -1,7 +0,0 @@
#[cfg(test)]
mod tests {
#[test]
fn it_works() {
assert_eq!(2 + 2, 4);
}
}