From fcfa3a82ef26cd5b8aa8ba3ce5f455dd94dc7cf9 Mon Sep 17 00:00:00 2001 From: Michael Davis Date: Fri, 4 May 2018 09:27:39 -0500 Subject: [PATCH] Update readme --- README.rst | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/README.rst b/README.rst index c7edc1c4..424394c2 100644 --- a/README.rst +++ b/README.rst @@ -27,15 +27,20 @@ Installation Custom Backends --------------- -As of 2.0.0, python-jose uses pycryptodome by default for RSA signing and verification. If -necessary, other RSA backends are supported. Both pycrpyto and crytography are options. +As of 3.0.0, python-jose uses the pure-python rsa module by default for RSA signing and verification. If +necessary, other RSA backends are supported. Options include crytography, pycryptodome, and pycrypto. In order to use a custom backend, install python-jose with the appropriate extra. +It is reccomended that a custom backend is used in production, as the pure-python rsa module is slow. + +The crytography option is a good default. + :: - $ pip install python-jose[pycrypto] $ pip install python-jose[crytography] + $ pip install python-jose[pycryptodome] + $ pip install python-jose[pycrypto] Usage