Permalink
Browse files

making the readme more compatible with pypi formatting

  • Loading branch information...
1 parent ab8821f commit a570234d0e50e46f59c6f839ef4b868f53958ec9 @progrium progrium committed Feb 24, 2011
Showing with 15 additions and 7 deletions.
  1. +3 −1 .gitignore
  2. +12 −6 README.md
View
@@ -1,3 +1,5 @@
*.pyc
**/*.pyc
-*.egg-info
+*.egg-info
+build
+dist
View
@@ -1,11 +1,14 @@
-# PyJWT
+PyJWT
+=====
A Python implementation of [JSON Web Token draft 01](http://self-issued.info/docs/draft-jones-json-web-token-01.html).
-## Installing
+Installing
+----------
sudo easy_install PyJWT
-## Usage
+Usage
+-----
import jwt
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
jwt.decode("someJWTstring", verify=False)
-## Algorithms
+Algorithms
+----------
The JWT spec supports several algorithms for cryptographic signing. This library currently supports:
@@ -30,12 +34,14 @@ Change the algorithm with by setting it in encode:
jwt.encode({"some": "payload"}, "secret", "HS512")
-## Tests
+Tests
+-----
You can run tests from the project root after installed with:
python tests/test_jwt.py
-## License
+License
+-------
MIT

0 comments on commit a570234

Please sign in to comment.