Skip to content

Commit a9c80c9

Browse files
committed
Added Command line instructions to README and docs
1 parent fb70578 commit a9c80c9

File tree

2 files changed

+37
-3
lines changed

2 files changed

+37
-3
lines changed

README.rst

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ Install with **pip**:
2929
3030
$ pip install PyJWT
3131
32+
3233
Usage
3334
-----
3435

@@ -41,11 +42,28 @@ Usage
4142
>>> jwt.decode(encoded, 'secret', algorithms=['HS256'])
4243
{'some': 'payload'}
4344
45+
46+
Command line
47+
------------
48+
49+
Usage::
50+
51+
pyjwt [options] INPUT
52+
53+
Decoding examples::
54+
55+
pyjwt --key=secret TOKEN
56+
pyjwt --no-verify TOKEN
57+
58+
See more options executing ``pyjwt --help``.
59+
60+
4461
Documentation
4562
-------------
4663

4764
View the full docs online at https://pyjwt.readthedocs.io/en/latest/
4865

66+
4967
Tests
5068
-----
5169

docs/index.rst

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
Welcome to ``PyJWT``
2-
===========================
2+
====================
33

44
``PyJWT`` is a Python library which allows you to encode and decode JSON Web
55
Tokens (JWT). JWT is an open, industry-standard (`RFC 7519`_) for representing
@@ -16,7 +16,7 @@ You can install ``pyjwt`` with ``pip``:
1616
See :doc:`Installation <installation>` for more information.
1717

1818
Example Usage
19-
------------
19+
-------------
2020

2121
.. code-block:: python
2222
@@ -28,9 +28,25 @@ Example Usage
2828
>>> jwt.decode('eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzb21lIjoicGF5bG9hZCJ9.4twFt5NiznN84AWoo1d7KO1T_yoc0Z6XOpOVswacPZg', 'secret')
2929
{'some': 'payload'}
3030
31-
3231
See :doc:`Usage Examples <usage>` for more examples.
3332

33+
Command line
34+
------------
35+
36+
Usage::
37+
38+
pyjwt [options] INPUT
39+
40+
Decoding examples::
41+
42+
pyjwt --key=secret TOKEN
43+
pyjwt --no-verify TOKEN
44+
45+
See more options executing ``pyjwt --help``.
46+
47+
Index
48+
-----
49+
3450
.. toctree::
3551
:maxdepth: 2
3652

0 commit comments

Comments
 (0)