From f7f0b7ffd6e31845a516a8176031c013ce55f36c Mon Sep 17 00:00:00 2001
From: Brandon Rodriguez <brodriguez8774@gmail.com>
Date: Thu, 2 Mar 2023 17:33:13 -0500
Subject: [PATCH] Update readme

---
 readme.md | 32 +++++++++++++++++++++++++++++++-
 1 file changed, 31 insertions(+), 1 deletion(-)

diff --git a/readme.md b/readme.md
index 5a56e86..3f5e2e0 100644
--- a/readme.md
+++ b/readme.md
@@ -1,4 +1,4 @@
-# Django Test Projects
+# Django Testing Sandbox
 
 
 ## Description
@@ -27,3 +27,33 @@ Currently included in this project are:
 
 Version 4.1 currently included because 4.x LTS is not yet out.
 Will switch over once v4 LTS is released.
+
+
+## Running Project
+
+In each project version, there is a `scripts/run_project.sh` file and a `scripts/run_pytests.sh` file.
+
+Change directory into the corresponding desired django project version, create/load a virtual environment, then run the corresponding desired script.
+
+
+## Provided Testing Users
+
+Each project has logic to automatically create a handful of user models for testing purposes:
+* Super User:
+** Username: `test_superuser`
+** Email: `test_superuser@example.com`
+** Permissions: is_active, is_superuser
+* Admin User:
+** Username: `test_admin`
+** Email: `test_superuser@example.com`
+** Permissions: is_active, is_staff
+* Standard User:
+** Username: `test_inactive`
+** Email: `test_superuser@example.com`
+** Permissions: None
+* Inactive User:
+** Username: `test_user`
+** Email: `test_superuser@example.com`
+** Permissions: is_active
+
+All users can have the default password `temppass2`.
-- 
GitLab