summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJosé Padilla <jpadilla@webapplicate.com>2014-01-18 14:06:32 -0400
committerJosé Padilla <jpadilla@webapplicate.com>2014-01-18 14:06:32 -0400
commitbfae3e9c9075db3ef95a41960e8c283dff4a32cc (patch)
treeb809e8f04b084e5bbb6dafb606d9a8566824a905
parent3d5ac645b1c1e08505c9cd1e07ef625533ee096f (diff)
downloadpyjwt-bfae3e9c9075db3ef95a41960e8c283dff4a32cc.tar.gz
Update README to reflect optional Crypto
-rw-r--r--README.md7
1 files changed, 5 insertions, 2 deletions
diff --git a/README.md b/README.md
index 2b84912..33d9a4a 100644
--- a/README.md
+++ b/README.md
@@ -6,6 +6,10 @@ Installing
----------
sudo easy_install PyJWT
+
+**Note**: The RSASSA-PKCS1-v1_5 algorithms depend on PyCrypto. If you plan on using any of those algorithms you'll need to install it as well.
+
+ sudo easy_install PyCrypto
Usage
-----
@@ -38,8 +42,7 @@ Change the algorithm with by setting it in encode:
jwt.encode({"some": "payload"}, "secret", "HS512")
For the RSASSA-PKCS1-v1_5 algorithms, the "secret" argument in jwt.encode is supposed to be a private RSA key as
-imported with Crypto.PublicKey.RSA.importKey. Likewise, the "secret" argument in jwt.decode is supposed to be the
-public RSA key imported with the same method.
+imported with Crypto.PublicKey.RSA.importKey. Likewise, the "secret" argument in jwt.decode is supposed to be the public RSA key imported with the same method.
Tests
-----