readme updates

.gitignore

@@ -3,4 +3,5 @@ __pycache__/
 sample_doc.docx
 ToDo.txt
 SE*
-uploaded_documents/
+uploaded_documents/
+test*

README.md

@@ -1,8 +1,33 @@
 # Mindsy.ai 
 
-## Overview
+![homepage](./assets/homepage.png)
+
 Mindsy.ai is a web application that allows users to upload documents, ask context-aware questions, and receive AI-generated responses. Built with a seamless React frontend and a robust FastAPI backend, the platform is designed to support professionals in domains like finance, legal, and healthcare by simplifying information retrieval from large documents. 
 
+## **Features**
+
+1. **Secure Document Upload**  
+   - The platform ensures data privacy and secure handling of uploaded files.  
+
+2. **Context-Aware AI Responses**  
+   - Provides highly accurate and context-aware answers based on the uploaded document.  
+   - Ideal for professionals in finance, legal, healthcare, and more.  
+
+3. **Image and OCR Support**  
+   - Extracts text from image-based documents with high accuracy using OCR (Optical Character Recognition).  
+   - Can read and derive insights from images embedded in docs including graphs, pie charts, etc. making it perfect for financial use-cases.
+
+4. **Markdown-Formatted Responses**  
+   - AI-generated responses are displayed in Markdown syntax, ensuring readability with formatted text, headings, bullet points, and code blocks.  
+
+5. **High-Performance Platform**  
+   - Optimized backend ensures fast query processing with minimal latency.  
+   - Can handle large documents and complex queries efficiently.  
+
+![chat interface](./assets/chat%20interface.png)
+
+In the above example, the app accurately understands a pie chart from a specifically mentioned page and provides a response in minimal time.
+
 ## Tools and Technologies Used
 
 - **FastAPI:** Handles API endpoints for document uploads and query processing.  
@@ -25,20 +50,23 @@ cd mindsy.ai
 1. Head to [Google AI Studio](https://ai.google.dev/gemini-api/docs) and get an API key for the Gemini 1.5 Flash model. It is free of cost and has a rate limit of 15 RPM and 1 million TPM (tokens per minute).
 
 2. Open the `sample.env` file in the root directory and paste your API key.
-```bash
-gemini_key = "YOUR_API_KEY" # do not rename the variable 'gemini_key'.
-```
+   ```bash
+   gemini_key = "YOUR_API_KEY" # do not rename the variable 'gemini_key'.
+   ```
 
 ### 3. Setting Up the Frontend 
-1. Navigate to the `landing-page` directory:  
+1. Navigate to the `landing-page` directory:
+
    ```bash  
    cd landing-page  
    ```  
 2. Install the dependencies:  
+
    ```bash  
    npm install  
    ```  
 3. Start the React development server:  
+
    ```bash  
    npm start  
    ```