From 986bd428d11e3795fc1c209d44b49ac500812ed9 Mon Sep 17 00:00:00 2001 From: jordan Date: Fri, 1 Nov 2024 13:42:18 -0500 Subject: [PATCH] small readme cleanup. --- pq/ml_dsa/README.md | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/pq/ml_dsa/README.md b/pq/ml_dsa/README.md index 5126c466..1f0423d2 100644 --- a/pq/ml_dsa/README.md +++ b/pq/ml_dsa/README.md @@ -1,6 +1,6 @@ # Description -Simple example of wolfCrypt ML-DSA signing and verifying. +Simple example of wolfCrypt ML-DSA keygen, signing, and verifying. Requires wolfSSL is built with: @@ -32,8 +32,11 @@ parms: -? show this help ``` -Signing and verifying a test message with Category 5, and writing the keys, -message, and signature to `*.key` and `*.bin` files: +## Keygen, sign, and verify + +This will generate a keypair with security category 5, then +sign and verify a test message, and write the keys, message, +and signature to `*.key` and `*.bin` files: ``` ./ml_dsa_test -c 5 -m "my test message" -w info: making key @@ -43,7 +46,9 @@ info: verify message good info: done ``` -The supported ML-DSA parameters: +## Print Supported ML-DSA Parameters + +To see the supported parameters: ``` ./ml_dsa_test -p