Update README.md

README.md

@@ -1,12 +1,38 @@
----
-title: Eco Property Retrofit
-emoji: 🚀
-colorFrom: blue
-colorTo: indigo
-sdk: gradio
-sdk_version: 4.31.5
-app_file: app.py
-pinned: false
----
-
-Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
+# EcoPropertyRetrofitGPT
+
+## Project Overview
+EcoPropertyRetrofitGPT is an AI-enhanced application designed to assist users in assessing and planning property retrofits. The application guides users through a series of questions, automatically generating a detailed retrofit plan based on their responses.
+
+## Technology Stack
+- **Frontend**: Gradio
+- **Backend**: FastAPI
+- **HTTP Client**: HTTPX
+- **Environment Variables Management**: OS
+
+## Setup Instructions
+1. Clone the repository.
+2. Install the required dependencies: `pip install -r requirements.txt`
+3. Run the application: `python app/app.py`
+
+## Application Features
+- **Personalization**: Domains, complexity, interaction styles, presentation styles, tone styles.
+- **Plugins**: Web search, knowledge library, advanced calculations.
+- **Commands**: Help, feedback, config, search, plan, generate_report, present_report.
+
+## Sequential Question Flow and Automatic Report Generation
+- Starts with the `start` command.
+- Series of questions leading to the generation of a detailed report.
+
+## Example Question Flow
+1. What type of property are you looking to retrofit? (a. Single-family home, b. Multi-family building, c. Other residential)
+2. What is the total area of your property in square feet?
+3. How old is the building?
+...
+20. Are you interested in financing options to cover retrofit costs? (a. Yes, b. No)
+
+## Report Content
+- Total Debt Servicing Ratio (TDSR)
+- Estimated retrofitting costs
+- Payments added to the mortgage
+- Energy cost savings from upgrades
+- Carbon footprint reduction