From 879ea091f4673c515e0abf6218b801ad1f605388 Mon Sep 17 00:00:00 2001
From: John Diginee <Johndbizz@gmail.com>
Date: Sat, 16 Sep 2023 19:25:40 +0100
Subject: [PATCH] Chore: Update readme file

---
 README.md        | 82 ++++++++++++++++++++++++++++++++++++++++++++++--
 core/settings.py |  3 --
 2 files changed, 80 insertions(+), 5 deletions(-)

diff --git a/README.md b/README.md
index e966057..55bc8e0 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,83 @@
 # Porto Shopping Mall API 
-Porto Shopping Mall API is an eCommerce store API that allows different software applications to communicate and interact with their platform.
+Porto Shopping Mall API is an eCommerce store API that allows different software applications to communicate and interact with their platform. This API enables the exchange of data and functionality (such as product, inventory, cart, and customer management, order processing, etc) between their store and other systems, such as mobile apps, third-party software, payment gateways, and more.
 
+## API Features
+
+### User Authentication
+* Register user
+* Login user
+* Change password
+* Password reset request
+* Password reset confirmation
+* Refresh token
+* Logout user
+
+### User Profile
+* Current user profile
+* Update user profile
+
+### Product
+* Create product
+* Upload product image
+* Delete product
+* Update product
+* List all products
+* Get single product
+
+### Order
+* Create order
+* Get all orders
+* Get single order
+* Delete order
+* Make payment
+* Process order
+
+### Review
+* Create product review
+* Update product review
+* Delete product review
+
+## Technologies Used
+ * Django
+ * Django Rest Framework
+ * JWT Authentication
+ * Mailtrap
+ * Stripe
+ * Amazon S3
+ * Postgres
+ * Github Actions (Continuous Integration/Continuous Deployment)
+ * Digital Ocean
+ * DRF-YASG (API Documentation)
+
+## Installation on local machine
+
+```bash
+git clone https://github.com/johndiginee/Porto_Shopping_Mall_API.git
+```
+```bash
 python3 -m venv venv
-source venv/bin/activate
\ No newline at end of file
+```
+```bash
+source venv/bin/activate
+```
+```bash
+pip install -r requirements.txt
+```
+```bash
+Set DEBUG = True in settings.py
+```
+```bash
+python3 manage.py makemigrations
+```
+```bash
+python3 manage.py migrate
+```
+```bash
+python3 manage.py runserver
+```
+
+## Authors
+John Diginee - [LinkedIn](https://www.linkedin.com/in/johndiginee/) / [X](http://x.com/johndiginee) / [Person Site](https://johndiginee.com)
+
+## Acknowledgements
+[Holberton School](https://www.holbertonschool.com/) & [ALX Africa](https://www.alxafrica.com/) (Mentors, Staff and Students)
\ No newline at end of file
diff --git a/core/settings.py b/core/settings.py
index 2bd7264..63b29a1 100644
--- a/core/settings.py
+++ b/core/settings.py
@@ -14,9 +14,6 @@
 import os
 from pathlib import Path
 from decouple import config
-# import dotenv
-
-# dotenv.read_dotenv()
 
 # Build paths inside the project like this: BASE_DIR / 'subdir'.
 BASE_DIR = Path(__file__).resolve().parent.parent