Update README.md

README.md

@@ -1,20 +1,47 @@
----
-title: TailorED
-emoji: 🚀
-colorFrom: red
-colorTo: red
-sdk: docker
-app_port: 8501
-tags:
-- streamlit
-pinned: false
-short_description: NLP research work 2025 for educational content
-license: mit
----
-
-# Welcome to Streamlit!
-
-Edit `/src/streamlit_app.py` to customize this app to your heart's desire. :heart:
-
-If you have any questions, checkout our [documentation](https://docs.streamlit.io) and [community
-forums](https://discuss.streamlit.io).
+# TailorED - AI-Powered Educational Content Generator
+
+A research prototype that uses AI to generate personalized educational content for students and tutors.
+
+## What is TailorED?
+
+TailorED helps create tailored educational content:
+- **For Students**: Simplifies complex course material into easy-to-understand explanations
+- **For Tutors**: Generates lesson plans, study guides, and teaching materials
+
+## Quick Start
+
+1. **Install dependencies**:
+   ```bash
+   pip install -r requirements.txt
+
+2. **Set up Environment Variables**:
+    ```bash
+    # Create .env file with your Groq API keys
+    GROQ_API_KEY_1=your_first_groq_key
+    GROQ_API_KEY_2=your_second_groq_key
+    DB_NAME=your-db-name
+    DB_USERNAME=your-postgre-username
+    DB_PASSWORD=your-postgre-password
+    DB_HOST=localhost
+    DB_PORT=5432   
+    MODEL_URL=url-of-research-model
+
+3. **Run the App**:
+    ```bash
+    streamlit run app.py
+
+4. **Recommended .env Template**:
+    ```bash
+    # .env
+    # Get your Groq API key from: https://console.groq.com
+    # 1. Go to console.groq.com
+    # 2. Create account/login
+    # 3. Click "API Keys" in top right
+    # 4. Create new key and copy it
+    # 5. Paste below:
+
+    # Minimum setup (one key):
+    GROQ_API_KEY_1=your_actual_groq_key_here
+
+    # Optional: Add second key for better reliability:
+    # GROQ_API_KEY_2=your_second_groq_key_here