From 34d5706b78e6ad7aaa229367169b4827f95ac2f1 Mon Sep 17 00:00:00 2001 From: Michael Date: Sat, 29 Feb 2020 23:23:47 -0600 Subject: [PATCH] Updates README --- README.md | 8 ++++++-- docs/index.rst | 2 +- 2 files changed, 7 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 09a0f5a..268c56a 100644 --- a/README.md +++ b/README.md @@ -4,11 +4,11 @@ Drop-in API endpoints for authentication in Django Rest Framework. -### Requirements +## Requirements - Django 2 or 3. - Python 3 -### Setup +## Quick Setup Install package @@ -31,6 +31,10 @@ Add URL patterns url(r'^dj-rest-auth/', include('dj_rest_auth.urls')) ] +### Documentation + +View the full documentation here: https://dj-rest-auth.readthedocs.io/en/latest/index.html + ### Acknowledgements diff --git a/docs/index.rst b/docs/index.rst index 0479561..8deb445 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -7,7 +7,7 @@ Welcome to dj-rest-auth's documentation! ============================================ -.. note:: dj-rest-auth from v0.3.3 supports django-rest-framework >= v3.0 +.. note:: dj-rest-auth supports django-rest-framework >= v3.0 |build-status| |coverage-status| |requirements-status| |docs|