Skip to content
This repository was archived by the owner on May 26, 2020. It is now read-only.

Commit e78d755

Browse files
committed
Use reStructuredText for README
1 parent bf629e2 commit e78d755

File tree

2 files changed

+57
-51
lines changed

2 files changed

+57
-51
lines changed

README.md

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

README.rst

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
REST framework JWT Auth
2+
=======================
3+
4+
|build-status-image| |pypi-version|
5+
6+
**JSON Web Token Authentication support for Django REST Framework**
7+
8+
Full documentation for the project is available at `docs`_.
9+
10+
Overview
11+
--------
12+
13+
This package provides `JSON Web Token Authentication`_ support for
14+
`Django REST framework`_.
15+
16+
If you want to know more about JWT, check out the following resources:
17+
18+
- DjangoCon 2014 - JSON Web Tokens `Video`_ \| `Slides`_
19+
- `Auth with JSON Web Tokens`_
20+
- `JWT.io`_
21+
22+
Requirements
23+
------------
24+
25+
- Python (2.7, 3.2, 3.3, 3.4)
26+
- Django (1.6, 1.7)
27+
- Django REST Framework (2.4.3, 2.4.4, 3.0.0)
28+
29+
Installation
30+
------------
31+
32+
Install using ``pip``\
33+
34+
.. code:: bash
35+
36+
$ pip install djangorestframework-jwt
37+
38+
Documentation & Support
39+
-----------------------
40+
41+
Full documentation for the project is available at `docs`_.
42+
43+
You may also want to follow the `author`_ on Twitter.
44+
45+
.. _docs: http://getblimp.github.io/django-rest-framework-jwt
46+
.. _JSON Web Token Authentication: http://tools.ietf.org/html/draft-ietf-oauth-json-web-token
47+
.. _Django REST framework: http://django-rest-framework.org/
48+
.. _Video: https://www.youtube.com/watch?v=825hodQ61bg
49+
.. _Slides: https://speakerdeck.com/jpadilla/djangocon-json-web-tokens
50+
.. _Auth with JSON Web Tokens: http://jpadilla.com/post/73791304724/auth-with-json-web-tokens
51+
.. _JWT.io: http://jwt.io/
52+
.. _author: https://twitter.com/blimp
53+
54+
.. |build-status-image| image:: https://secure.travis-ci.org/GetBlimp/django-rest-framework-jwt.png?branch=master
55+
:target: http://travis-ci.org/GetBlimp/django-rest-framework-jwt?branch=master
56+
.. |pypi-version| image:: https://pypip.in/version/djangorestframework-jwt/badge.svg
57+
:target: https://pypi.python.org/pypi/djangorestframework-jwt

0 commit comments

Comments
 (0)