Skip to content

Commit c5ea688

Browse files
author
Adam Chainz
committed
Convert README from Markdown to reStructuredText
PyPI only supports reStructuredText, so this won't look broken there now.
1 parent b144666 commit c5ea688

File tree

4 files changed

+58
-55
lines changed

4 files changed

+58
-55
lines changed

MANIFEST.in

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
include README.md
1+
include README.rst
22
include CHANGELOG.md
33
include LICENSE
44
include AUTHORS

README.md

Lines changed: 0 additions & 53 deletions
This file was deleted.

README.rst

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
PyJWT
2+
=====
3+
4+
.. image:: https://secure.travis-ci.org/jpadilla/pyjwt.svg?branch=master
5+
:target: http://travis-ci.org/jpadilla/pyjwt?branch=master
6+
7+
.. image:: https://ci.appveyor.com/api/projects/status/h8nt70aqtwhht39t?svg=true
8+
:target: https://ci.appveyor.com/project/jpadilla/pyjwt
9+
10+
.. image:: https://img.shields.io/pypi/v/pyjwt.svg
11+
:target: https://pypi.python.org/pypi/pyjwt
12+
13+
.. image:: https://coveralls.io/repos/jpadilla/pyjwt/badge.svg?branch=master
14+
:target: https://coveralls.io/r/jpadilla/pyjwt?branch=master
15+
16+
.. image:: https://readthedocs.org/projects/pyjwt/badge/?version=latest
17+
:target: https://pyjwt.readthedocs.io
18+
19+
A Python implementation of `RFC
20+
7519 <https://tools.ietf.org/html/rfc7519>`_. Original implementation
21+
was written by `@progrium <https://github.com/progrium>`_.
22+
23+
Installing
24+
----------
25+
26+
Install with **pip**:
27+
28+
.. code-block:: sh
29+
30+
$ pip install PyJWT
31+
32+
Usage
33+
-----
34+
35+
.. code:: python
36+
37+
>>> import jwt
38+
>>> encoded = jwt.encode({'some': 'payload'}, 'secret', algorithm='HS256')
39+
'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzb21lIjoicGF5bG9hZCJ9.4twFt5NiznN84AWoo1d7KO1T_yoc0Z6XOpOVswacPZg'
40+
41+
>>> jwt.decode(encoded, 'secret', algorithms=['HS256'])
42+
{'some': 'payload'}
43+
44+
Documentation
45+
-------------
46+
47+
View the full docs online at https://pyjwt.readthedocs.io/en/latest/
48+
49+
Tests
50+
-----
51+
52+
You can run tests from the project root after cloning with:
53+
54+
.. code-block:: sh
55+
56+
$ python setup.py test

setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ def get_version(package):
1818

1919
version = get_version('jwt')
2020

21-
with open(os.path.join(os.path.dirname(__file__), 'README.md')) as readme:
21+
with open(os.path.join(os.path.dirname(__file__), 'README.rst')) as readme:
2222
long_description = readme.read()
2323

2424
if sys.argv[-1] == 'publish':

0 commit comments

Comments
 (0)