Skip to content

Commit 208a093

Browse files
committed
readme
1 parent 24d50ca commit 208a093

File tree

1 file changed

+7
-10
lines changed

1 file changed

+7
-10
lines changed

projects/pypqc/README.rst

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,12 @@
11
Usage
22
=====
33

4-
5-
Simply install from PyPI with ``pip install "pypqc[kyber,falcon,hqc]"``, or
6-
see "Development" below if you want to tinker on the codebase!
7-
4+
Simply install from PyPI with ``pip install "pypqc[kyber,falcon,hqc] >= 0.9" --extra-index-url "https://test.pypi.org/simple/"``,
5+
or see "Development" below if you want to tinker on the codebase!
86

97
KEMs
108
----
119

12-
1310
McEliece, ML-KEM (aka FIPS 203 or Kyber), and HQC are currently provided,
1411
all with the same interface.::
1512

@@ -44,13 +41,12 @@ it.)
4441
Signature Algorithms
4542
--------------------
4643

47-
SPHINCS+, Dilithium, and Falcon are provided, all with the same interface.::
44+
SPHINCS+, ML-DSA (aka FIPS 204 or Dilithium), and Falcon are currently provided,
45+
all with the same interface.::
4846

49-
import os; MESSAGE = os.urandom(42)
50-
51-
# Available: ml_dsa_44, ml_dsa_65, ml_dsa_87,
52-
# falcon_512, falcon_1024,
47+
# Available: falcon_512, falcon_1024,
5348
# falcon_padded_512, falcon_padded_1024,
49+
# ml_dsa_44, ml_dsa_65, ml_dsa_87,
5450
# sphincs_sha2_128f_simple, sphincs_sha2_128s_simple,
5551
# sphincs_shake_128f_simple, sphincs_shake_128s_simple,
5652
# sphincs_sha2_192f_simple, sphincs_sha2_192s_simple,
@@ -66,6 +62,7 @@ SPHINCS+, Dilithium, and Falcon are provided, all with the same interface.::
6662
6763
# 2. Signing
6864
# (detached signature)
65+
import os; MESSAGE = os.urandom(42)
6966
sig = sigalg.sign(MESSAGE, sk)
7067
7168

0 commit comments

Comments
 (0)