From d9f0a5fc281e958ffa3ac29a45b100e1f64dd419 Mon Sep 17 00:00:00 2001
From: ben_son <136886788+ben-24-0@users.noreply.github.com>
Date: Mon, 26 Jan 2026 14:19:13 +0530
Subject: [PATCH] Create README.md for crowd detection script

Added a README file with project overview, functionality, and usage instructions.
---
 README.md | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..fb894b9
--- /dev/null
+++ b/README.md
@@ -0,0 +1,24 @@
+# 👥 Crowd Detection Script
+
+## Overview
+This is a simple Python script that estimates the number of people in an image using a crowd detection function. The project demonstrates basic usage of a pre implemented detection module to process an input image and return an estimated crowd count.
+
+This repository is a forked project and has been used for learning and experimentation purposes.
+
+---
+
+## How It Works
+- An image path is provided as input
+- The image is passed to a crowd detection function
+- The function analyzes the image and returns an estimated count
+- The result is printed to the console
+
+---
+
+## Usage
+1. Place the image inside the `images` folder
+2. Update the image path in the script if needed
+3. Run the script
+
+```bash
+python main.py