From aafd10fccee96a545f0b711f8dbaa52bba49c99c Mon Sep 17 00:00:00 2001 From: Michael Date: Sat, 29 Feb 2020 23:02:01 -0600 Subject: [PATCH] Updates README --- README.md | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) diff --git a/README.md b/README.md index 076cce2..79125b2 100644 --- a/README.md +++ b/README.md @@ -2,3 +2,32 @@ [![](https://circleci.com/gh/iMerica/dj-rest-auth.svg?style=svg)](https://app.circleci.com/github/iMerica/dj-rest-auth/pipelines) +Drop-in API endpoints for authentication in Django Rest Framework. + +### Requirements +- Django 2 or 3. +- Python 3 + +### Setup + +Install package + + pip install dj-rest-auth + +Add `dj_rest_auth` app to INSTALLED_APPS in your django settings.py: + + INSTALLED_APPS = ( + ..., + 'rest_framework', + 'rest_framework.authtoken', + ..., + 'rest_auth' + ) + +Add URL patterns + + + urlpatterns = [ + url(r'^dj-rest-auth/', include('dj_rest_auth.urls')) + ] +