Skip to content

Commit a570234

Browse files
committed
making the readme more compatible with pypi formatting
1 parent ab8821f commit a570234

File tree

2 files changed

+15
-7
lines changed

2 files changed

+15
-7
lines changed

.gitignore

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
11
*.pyc
22
**/*.pyc
3-
*.egg-info
3+
*.egg-info
4+
build
5+
dist

README.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,14 @@
1-
# PyJWT
1+
PyJWT
2+
=====
23
A Python implementation of [JSON Web Token draft 01](http://self-issued.info/docs/draft-jones-json-web-token-01.html).
34

4-
## Installing
5+
Installing
6+
----------
57

68
sudo easy_install PyJWT
79

8-
## Usage
10+
Usage
11+
-----
912

1013
import jwt
1114
jwt.encode({"some": "payload"}, "secret")
@@ -18,7 +21,8 @@ If the secret is wrong, it will raise a `jwt.DecodeError` telling you as such. Y
1821

1922
jwt.decode("someJWTstring", verify=False)
2023

21-
## Algorithms
24+
Algorithms
25+
----------
2226

2327
The JWT spec supports several algorithms for cryptographic signing. This library currently supports:
2428

@@ -30,12 +34,14 @@ Change the algorithm with by setting it in encode:
3034

3135
jwt.encode({"some": "payload"}, "secret", "HS512")
3236

33-
## Tests
37+
Tests
38+
-----
3439

3540
You can run tests from the project root after installed with:
3641

3742
python tests/test_jwt.py
3843

39-
## License
44+
License
45+
-------
4046

4147
MIT

0 commit comments

Comments
 (0)