added readme file

README.md

@@ -1,35 +1,44 @@
 ---
-title: Student Performance Predictor
+title: Math Score ML Project
 emoji: 📊
 colorFrom: blue
-colorTo: indigo
+colorTo: purple
 sdk: docker
 app_file: app.py
 pinned: false
 ---
 
-# Student Performance Predictor 🎓
+# Math Score Predictor
 
-This is an ML web app that predicts student math scores based on:
-- Gender
-- Race/Ethnicity
-- Parental Education Level
-- Lunch Type
-- Test Preparation Course
-- Reading Score
-- Writing Score
+A machine learning project to predict math scores based on student attributes and test preparation.
 
-## How to Use
+## Features
 
-1. Visit the app
-2. Fill in the student details
-3. Get the predicted math score
+- Predicts math scores using reading and writing scores plus student demographics
+- Built with Flask and scikit-learn
+- Docker containerized for easy deployment
 
-## Tech Stack
-- Flask (Backend)
-- Scikit-learn (ML Model)
-- Docker (Deployment)
+## How to Run Locally
 
----
+```bash
+pip install -r requirements.txt
+python app.py
+```
+
+Then visit `http://localhost:7860`
+
+## API Usage
+
+Send a POST request to `/predict` with JSON data:
 
-## Your project description here...
+```json
+{
+  "gender": "male",
+  "race": "group A",
+  "parental_education": "some high school",
+  "lunch": "standard",
+  "test_preparation_course": "none",
+  "reading_score": 72,
+  "writing_score": 74
+}
+```