From c02db2cc04413abea520963dffd83642f2af4ebe Mon Sep 17 00:00:00 2001
From: Ishaan Mittal <ishaan@truefoundry.com>
Date: Sat, 17 Aug 2024 17:27:23 +0530
Subject: [PATCH] update readme

---
 README.md | 15 ++++++++++++++-
 1 file changed, 14 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index f6edb35..35a3014 100644
--- a/README.md
+++ b/README.md
@@ -94,10 +94,23 @@ Before you begin, ensure you have the following installed:
 7. Edit the environment variables in `.env` file
 8. Finally run
     ```shell
-    $ python manage.py runserver
+    python manage.py runserver
     ```
 _Note:_ SQLite is as the default database
 
+### Pre-Commit Hooks
+
+1. This project uses pre-commit hooks to ensure code quality. To install pre-commit hooks, run the following command:
+    ```shell
+    pip install pre-commit
+    pre-commit install
+    ```
+
+2. To run pre-commit hooks manually, run the following command:
+    ```shell
+    pre-commit run --all-files
+    ```
+
 ## Roadmap
 
 - [x] Student Information Access