Skip to content

Commit 986bd42

Browse files
committed
small readme cleanup.
1 parent dca01c7 commit 986bd42

1 file changed

Lines changed: 9 additions & 4 deletions

File tree

pq/ml_dsa/README.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Description
22

3-
Simple example of wolfCrypt ML-DSA signing and verifying.
3+
Simple example of wolfCrypt ML-DSA keygen, signing, and verifying.
44

55
Requires wolfSSL is built with:
66

@@ -32,8 +32,11 @@ parms:
3232
-? show this help
3333
```
3434

35-
Signing and verifying a test message with Category 5, and writing the keys,
36-
message, and signature to `*.key` and `*.bin` files:
35+
## Keygen, sign, and verify
36+
37+
This will generate a keypair with security category 5, then
38+
sign and verify a test message, and write the keys, message,
39+
and signature to `*.key` and `*.bin` files:
3740
```
3841
./ml_dsa_test -c 5 -m "my test message" -w
3942
info: making key
@@ -43,7 +46,9 @@ info: verify message good
4346
info: done
4447
```
4548

46-
The supported ML-DSA parameters:
49+
## Print Supported ML-DSA Parameters
50+
51+
To see the supported parameters:
4752

4853
```
4954
./ml_dsa_test -p

0 commit comments

Comments
 (0)