Skip to content

Commit bca54cd

Browse files
committed
Some README clarifications.
1 parent ffca6c1 commit bca54cd

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ Installing
88
sudo easy_install PyJWT
99

1010
**A Note on Dependencies**:
11+
1112
The RSASSA-PKCS1-v1_5 algorithms depend on PyCrypto. If you plan on
1213
using any of those algorithms, you'll need to install it as well.
1314

@@ -59,10 +60,11 @@ Change the algorithm with by setting it in encode:
5960

6061
When using the RSASSA-PKCS1-v1_5 algorithms, the `key` argument in both
6162
`jwt.encode()` and `jwt.decode()` (`"secret"` in the examples) is expected to
62-
be an RSA private key as imported with `Crypto.PublicKey.RSA.importKey()`.
63+
be an RSA public or private key as imported with `Crypto.PublicKey.RSA.importKey()`.
6364

6465
When using the ECDSA algorithms, the `key` argument is expected to
65-
be an Elliptic Curve signing key as imported with `ecdsa.SigningKey.from_pem()`.
66+
be an Elliptic Curve private key as imported with `ecdsa.SigningKey.from_pem()`,
67+
or a public key as imported with `ecdsa.VerifyingKey.from_pem()`.
6668

6769
Tests
6870
-----

0 commit comments

Comments
 (0)