From cf8fe0bc311c2c4acca740124cb3cb872423d00c Mon Sep 17 00:00:00 2001
From: "hasnain.ahmed" <hasnain.ahmed@vectracom.com>
Date: Sun, 2 Nov 2025 18:52:02 +0500
Subject: [PATCH] clear and concise readme is created

---
 README.md | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/README.md b/README.md
index e69de29..86d859e 100644
--- a/README.md
+++ b/README.md
@@ -0,0 +1,7 @@
+to run this project follow the following steps.
+
+uv sync
+source .venv/bin/activate
+uvicorn main:app --reload --port=8899
+
+the fastapi will be server at localhost port 8899, you may go to the localhost:8899/docs, to try the GET search API, and further API docs.
\ No newline at end of file