Skip to content

Commit 6163966

Browse files
davisnandomikedebock
authored andcommitted
Add read the docs and badge to readme
1 parent 254bbf8 commit 6163966

File tree

2 files changed

+28
-0
lines changed

2 files changed

+28
-0
lines changed

README.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,9 @@ Status
1515
.. image:: https://img.shields.io/pypi/v/django-cognito-jwt.svg
1616
:target: https://pypi.python.org/pypi/django-cognito-jwt/
1717

18+
.. image:: https://readthedocs.org/projects/django-cognito-jwt/badge/?version=latest
19+
:target: https://django-cognito-jwt.readthedocs.io/en/latest/?badge=latest
20+
:alt: Documentation Status
1821

1922
Installation
2023
============

docs/index.rst

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,28 @@ Installation
99
.. code-block:: shell
1010
1111
pip install django_cognito_jwt
12+
13+
14+
Usage
15+
=====
16+
17+
Add the following lines to your Django settings.py file:
18+
19+
.. code-block:: python
20+
21+
COGNITO_AWS_REGION = '<aws region>' # 'eu-central-1'
22+
   COGNITO_USER_POOL = '<user pool>' # 'eu-central-1_xYzaq'
23+
   COGNITO_AUDIENCE = '<client id>'
24+
25+
Also update the rest framework settings to use the correct authentication backend:
26+
27+
.. code-block:: python
28+
29+
REST_FRAMEWORK = {
30+
'DEFAULT_AUTHENTICATION_CLASSES': [
31+
...
32+
'django_cognito_jwt.JSONWebTokenAuthentication',
33+
...
34+
],
35+
...
36+
}

0 commit comments

Comments
 (0)