add metadata and readme

cryspen · Aug 22, 2024 · 3acd7fe · 3acd7fe
1 parent 590d2c5
commit 3acd7fe
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 0 deletions.
diff --git a/hpke-rs-tests/Cargo.toml b/hpke-rs-tests/Cargo.toml
@@ -1,7 +1,12 @@
 [package]
 name = "hpke-rs-tests"
 version = "0.1.0"
+authors = [ "Cryspen" ]
 edition = "2021"
+license = "MPL-2.0"
+readme = "Readme.md"
+description = "Tests for crypto providers"
+repository = "https://github.com/franziskuskiefer/hpke-rs"
 
 [dependencies]
 hpke-rs = { version = "0.2.0", features = [

diff --git a/hpke-rs-tests/Readme.md b/hpke-rs-tests/Readme.md
@@ -0,0 +1,19 @@
+# Tests for Crypto Providers
+
+This crate exposes macros that define crypto provider test functions.
+
+## Usage
+
+```rust
+struct MyCryptoProvider;
+
+impl hpke_rs_crypto::CryptoProvider for MyCryptoProvider {
+    // ...
+}
+
+#[cfg(tests)]
+mod tests {
+    hpke_rs_tests::test_funs!(MyCryptoProvider);
+    hpke_rs_tests::kat_fun!(MyCryptoProvider);
+}
+```