diff options
author | Mariano Ruiz <mrsarm@gmail.com> | 2017-05-06 14:09:52 -0300 |
---|---|---|
committer | Mariano Ruiz <mrsarm@gmail.com> | 2017-05-06 14:09:52 -0300 |
commit | a9c80c9b33bd382ecb40c631c5bc4819ffe4c633 (patch) | |
tree | a01c4b025dcd80032e9f94948009e2c2f9674e10 | |
parent | fb7057850feb7edc9b2d0815d0afba7854dc4af3 (diff) | |
download | pyjwt-a9c80c9b33bd382ecb40c631c5bc4819ffe4c633.tar.gz |
Added Command line instructions to README and docs
-rw-r--r-- | README.rst | 18 | ||||
-rw-r--r-- | docs/index.rst | 22 |
2 files changed, 37 insertions, 3 deletions
@@ -29,6 +29,7 @@ Install with **pip**: $ pip install PyJWT + Usage ----- @@ -41,11 +42,28 @@ Usage >>> jwt.decode(encoded, 'secret', algorithms=['HS256']) {'some': 'payload'} + +Command line +------------ + +Usage:: + + pyjwt [options] INPUT + +Decoding examples:: + + pyjwt --key=secret TOKEN + pyjwt --no-verify TOKEN + +See more options executing ``pyjwt --help``. + + Documentation ------------- View the full docs online at https://pyjwt.readthedocs.io/en/latest/ + Tests ----- diff --git a/docs/index.rst b/docs/index.rst index 782031a..823f117 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,5 +1,5 @@ Welcome to ``PyJWT`` -=========================== +==================== ``PyJWT`` is a Python library which allows you to encode and decode JSON Web Tokens (JWT). JWT is an open, industry-standard (`RFC 7519`_) for representing @@ -16,7 +16,7 @@ You can install ``pyjwt`` with ``pip``: See :doc:`Installation <installation>` for more information. Example Usage ------------- +------------- .. code-block:: python @@ -28,9 +28,25 @@ Example Usage >>> jwt.decode('eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzb21lIjoicGF5bG9hZCJ9.4twFt5NiznN84AWoo1d7KO1T_yoc0Z6XOpOVswacPZg', 'secret') {'some': 'payload'} - See :doc:`Usage Examples <usage>` for more examples. +Command line +------------ + +Usage:: + + pyjwt [options] INPUT + +Decoding examples:: + + pyjwt --key=secret TOKEN + pyjwt --no-verify TOKEN + +See more options executing ``pyjwt --help``. + +Index +----- + .. toctree:: :maxdepth: 2 |