📝 Updated README with full Hugging Face Space + API deployment guide

README.md

@@ -67,90 +67,115 @@ license: mit
 ```bash
 git clone https://github.com/subatomicERROR/Quantum-API.git
 cd Quantum-API
+```
 
-2. Create a Virtual Environment (Recommended)
-
+### 2. Create a Virtual Environment (Recommended)
+```bash
 python3 -m venv qvenv
 source qvenv/bin/activate  # For Linux/macOS
 # OR
 qvenv\Scripts\activate  # For Windows
+```
 
-3. Install Requirements
-
+### 3. Install Requirements
+```bash
 pip install -r requirements.txt
+```
 
-🚀 Running the App Locally
-1. Start the Backend (FastAPI)
+---
+
+## 🚀 Running the App Locally
 
+### 1. Start the Backend (FastAPI)
+```bash
 uvicorn api.endpoints.codelama:app --host 0.0.0.0 --port 7860 --reload
+```
 
-Accessible at: http://localhost:7860
-2. Start the Frontend (Streamlit)
+Accessible at: [http://localhost:7860](http://localhost:7860)
 
+### 2. Start the Frontend (Streamlit)
+```bash
 streamlit run app/app.py --server.port 7861
+```
 
-Accessible at: http://localhost:7861
-🔌 API Endpoints
-🌐 Root
+Accessible at: [http://localhost:7861](http://localhost:7861)
 
-GET /
+---
+
+## 🔌 API Endpoints
 
-    Returns an SEO-optimized HTML homepage.
+### 🌐 Root
 
-⚛️ Quantum Endpoint
+**GET /**
 
-POST /quantum-endpoint
+Returns an SEO-optimized HTML homepage.
 
-Request Body:
+### ⚛️ Quantum Endpoint
 
+**POST /quantum-endpoint**
+
+**Request Body:**
+```json
 {
   "data": "your_data_here",
   "quantum_factor": 1.0
 }
+```
 
-Response:
-
+**Response:**
+```json
 {
   "status": "success",
   "quantum_result": "Processed your_data_here with quantum factor 1.0"
 }
+```
 
-❤️ Health Check
+### ❤️ Health Check
 
-GET /health
+**GET /health**
 
 Returns API status.
-📜 Streamlit Frontend
 
-    An interactive interface to interact with the quantum backend.
+---
 
-streamlit run app/app.py --server.port 7861
+## 📜 Streamlit Frontend
 
-URL: http://localhost:7861
-📦 Deployment: Hugging Face Spaces
+An interactive interface to interact with the quantum backend.
 
-To deploy on Hugging Face:
+```bash
+streamlit run app/app.py --server.port 7861
+```
 
-    Ensure the following in your repo:
+URL: [http://localhost:7861](http://localhost:7861)
 
-        requirements.txt
+---
 
-        app/app.py (Streamlit entrypoint)
+## 📦 Deployment: Hugging Face Spaces
 
-        api/endpoints/codelama.py (FastAPI backend)
+To deploy on Hugging Face:
 
-    Use a Docker-based Space with this command in Dockerfile or runtime:
+Ensure the following in your repo:
+- `requirements.txt`
+- `app/app.py` (Streamlit entrypoint)
+- `api/endpoints/codelama.py` (FastAPI backend)
 
+Use a Docker-based Space with this command in Dockerfile or runtime:
+```bash
 uvicorn api.endpoints.codelama:app --host 0.0.0.0 --port 7860 & \
 streamlit run app/app.py --server.port 7861
+```
 
 Push your repo to Hugging Face:
+```bash
+git remote add hf https://huggingface.co/spaces/subatomicERROR/Quantum-API
+git push hf main
+```
 
-    git remote add hf https://huggingface.co/spaces/subatomicERROR/Quantum-API
-    git push hf main
+---
 
-📁 File Structure
+## 📁 File Structure
 
+```
 Quantum-API/
 ├── api/
 │   └── endpoints/
@@ -160,26 +185,34 @@ Quantum-API/
 ├── requirements.txt
 ├── README.md
 └── .huggingface/README.md      # Optional Space ReadMe
+```
 
-🧠 Author
+---
+
+## 🧠 Author
 
-Built with ☕ + ⚛️ by subatomicERROR (Yash R)
-Email: [email protected]
-🧬 Branding & Philosophy
+Built with ☕ + ⚛️ by **subatomicERROR** (Yash R)  
+📧 Email: [email protected]
 
-    Part of the .ERROR brand — combining ancient wisdom, futuristic design, and quantum intelligence.
+---
 
-This system is part of the Quantum-AI Stack including:
+## 🧬 Branding & Philosophy
 
-    Quantum-ML — Model & training backend.
+> Part of the `.ERROR` brand — combining ancient wisdom, futuristic design, and quantum intelligence.
 
-    Quantum-API — This API gateway.
+This system is part of the **Quantum-AI Stack** including:
 
-    Quantum-Compute — Quantum computation engine.
+- **Quantum-ML** — Model & training backend.
+- **Quantum-API** — This API gateway.
+- **Quantum-Compute** — Quantum computation engine.
 
-📃 License
+---
 
-MIT License
+## 📃 License
+
+**MIT License**
+
+---
 
-🪐 Exploring the quantum realm with AI...
-...one entangled bit at a time.
+🪐 Exploring the quantum realm with AI...  
+...one entangled bit at a time.