From 554d1e6691b0443df25792a614ec255e46fd6918 Mon Sep 17 00:00:00 2001 From: Chandan Gowda <41890434+chandansgowda@users.noreply.github.com> Date: Mon, 21 Aug 2023 13:50:54 +0530 Subject: [PATCH] docs: update README.md --- README.md | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 50d959f..a9714e2 100644 --- a/README.md +++ b/README.md @@ -1 +1,18 @@ -# Token Authentication Django API \ No newline at end of file +# Token Authentication Django API + +[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/chandansgowda/token-auth-django/CI)](https://github.com/chandansgowda/token-auth-django/actions) + +A robust User Authentication REST API built with Django Rest Framework, employing Test-Driven Development (TDD) practices. The API provides token-based authentication for secure user access. + +## Features + +- Token-based User Authentication for secure API access. +- Test-Driven Development (TDD) approach for reliable and maintainable code. +- Containerized with Docker for consistent deployment and isolation. +- GitHub Actions for automated testing, and linting validation. +- PostgreSQL wait mechanism to ensure Django service waits for the database to be ready. +- Swagger documentation with DRF Spectacular for seamless API exploration. + +## Swagger Screenshot +Screenshot 2023-08-21 at 1 37 09 PM +