Skip to content

Commit 09b04f3

Browse files
brentrubrentru
authored andcommitted
add deps, add encoding schemes to README
1 parent 3e2f761 commit 09b04f3

File tree

2 files changed

+16
-3
lines changed

2 files changed

+16
-3
lines changed

README.rst

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,15 +14,22 @@ Introduction
1414
:alt: Build Status
1515

1616
JSON Web Token (JWT) Authentication module for CircuitPython. JSON Web Tokens are an open, industry standard
17-
`RFC 7519 <https://tools.ietf.org/html/rfc7519>`_ method for representing claims securely between two parties. Module
18-
includes methods for JWT generation and verification.
17+
`RFC 7519 <https://tools.ietf.org/html/rfc7519>`_ method for representing claims securely between two parties.
18+
19+
This library currently supports the following signature algorithms:
20+
* No encoding, "none"
21+
* RS256/SHA-256 (via `Adafruit_CircuitPython_RSA <https://github.com/adafruit/Adafruit_CircuitPython_RSA>`_)
22+
* RS384/SHA-384 (via `Adafruit_CircuitPython_RSA <https://github.com/adafruit/Adafruit_CircuitPython_RSA>`_)
23+
* RS512/SHA-512 (via `Adafruit_CircuitPython_RSA <https://github.com/adafruit/Adafruit_CircuitPython_RSA>`_)
1924

2025

2126
Dependencies
2227
=============
2328
This driver depends on:
2429

2530
* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_
31+
* `Adafruit_CircuitPython_RSA <https://github.com/adafruit/Adafruit_CircuitPython_RSA>`_
32+
* `Adafruit_CircuitPython_binascii <https://github.com/adafruit/Adafruit_CircuitPython_binascii>`_
2633

2734
Please ensure all dependencies are available on the CircuitPython filesystem.
2835
This is easily achieved by downloading
@@ -58,7 +65,9 @@ To install in a virtual environment in your current project:
5865
Usage Example
5966
=============
6067

61-
.. todo:: Add a quick, simple example. It and other examples should live in the examples folder and be included in docs/examples.rst.
68+
.. code-block:: python
69+
70+
6271
6372
Contributing
6473
============

adafruit_jwt.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,10 @@
3939
4040
* Adafruit's RSA library:
4141
https://github.com/adafruit/Adafruit_CircuitPython_RSA
42+
43+
* Adafruit's binascii library:
44+
https://github.com/adafruit/Adafruit_CircuitPython_RSA
45+
4246
"""
4347
import io
4448
import json

0 commit comments

Comments
 (0)