Updated readme and example pic

README.md

@@ -1,2 +1,80 @@
-# EconomicsOfAHeatPump
+# Economics of a Heat Pump
+
+## Introduction
+The **Economics of a Heat Pump** project focuses on analyzing and comparing the economic aspects of various heating technologies, including heat pumps. The primary goal is to evaluate the costs, savings, and return on investment associated with different heating systems to help users make informed decisions based on financial metrics.
+
+
+## Table of Contents
+- [Project Overview](#project-overview)
+- [Technologies Used](#technologies-used)
+- [Installation Instructions](#installation-instructions)
+- [Usage](#usage)
+- [Contributing](#contributing)
+- [License](#license)
+- [Contact Information](#contact-information)
+- [Example Image](#example-image)
+
+## Project Overview
+This project investigates the economic factors involved in heating technologies, including:
+- Initial investment costs
+- Operational and maintenance expenses
+- Long-term savings and return on investment
+Comparative analysis of heat pumps versus other heating systems
+
+## Technologies Used
+The project utilizes the following technologies:
+- **Programming Language**: Python
+- **Libraries**: NumPy, Pandas, Matplotlib for data analysis and visualization
+
+## Installation Instructions
+To set up the project locally, follow these steps:
+
+1. **Clone the repository**:
+   ```bash
+   git clone https://git.stiefel.tech/m3x1m0m/EconomicsOfAHeatPump.git
+   cd EconomicsOfAHeatPump
+   ```
+
+2. **Install dependencies**:
+   Make sure you have Python installed, then run:
+   ```bash
+   pip install -r requirements.txt
+   ```
+
+3. **Create your own JSON file**:
+   The project includes an example JSON file (`example.json`) that serves as a template for your data. To get started:
+   - Create your own JSON file based on the structure provided in `example.json`.
+   - This file should include details about the heat pump system and any other technologies you wish to compare.
+   - You can compare as many or as few technologies as you want by adjusting the contents of your JSON file.
+
+## Usage
+To utilize this project effectively:
+1. Open the main Python script in your preferred code editor.
+2. Load your JSON file containing the relevant data.
+3. Follow the instructions within the script to perform analyses on heat pump economics.
+
+The following example prints installation cost, expenditure (e.g. electricity bills), total and grand total for every year and plots the data.
+
+ ```bash
+python heatpump.py --settings example.json --years 30 --plot
+ ```
+
+ ![30 years](https://git.stiefel.tech/m3x1m0m/EconomicsOfAHeatPump/raw/branch/master/pictures/example.png)
+
+## Contributing
+Contributions are welcome! If you would like to contribute to this project, please follow these steps:
+1. Fork the repository.
+2. Create a new branch for your feature or bug fix.
+3. Commit your changes and push them to your branch.
+4. Submit a pull request detailing your changes.
+
+## License
+This project is licensed under the MIT License - see the [LICENSE](https://git.stiefel.tech/m3x1m0m/EconomicsOfAHeatPump/src/branch/master/LICENSE) file for details.
+
+## Contact Information
+For any inquiries or feedback regarding this project, please contact:
+- **Author**: Maximilian Stiefel
+- **Email**: stiefel.maximilian[ät]online.de
+
+Feel free to reach out with questions or suggestions!