revert readme

Author: maralzar

README.md

@@ -1,84 +1,61 @@
 # DevOps-GPT
-
 Use a brilliant assistant as your friend in your DevOps Journey.
 
 ## What does this project offer?
-
-This project helps you to balance your daily work as a DevOps engineer, from simple bug fixes to project template generation.
-You don't need to search on Google for some routine jobs, and it helps you with a robust prompt to simplify your career.
+This project helps you to balance your daily work as a DevOps engineer, from simple bug fixes to project template generation.<br />
+you don't need to search on Google for some routine jobs and it helps you with a robust prompt to simplify your career.
 
 ## How it works?
+This is a wrapper between DevOps engineers and large language models like GPT-4-mini. The main strength of it is prompt engineering.<br />
 
-This is a wrapper between DevOps engineers and large language models like GPT-4-mini. The main strength of it is prompt engineering.
-
-We have developed some (extendable) prompt-driven solutions with a simplified interface for the DevOps process cost reduction.
+We have developed some (Extendable) prompt-driven solutions with a simplified interface for the DevOps process cost reduction.<br />
 
 ### Docker services
-
-We run our services using docker-compose (the main Fast-API-based backend and MongoDB), so we package all dependencies and don't use any external service.
-The second one is MongoDB. We need to save the prompt and GPT-4-mini response in the Mongo document for future use (e.g., fine-tuning another model with our data).
+We run our services using docker-compose (the main Fast-API-based backend and MongoDB), so we package all dependencies and don't use any external service.<br />
+The second one is Mongodb. we need to save the prompt and GPT-4_mini response in the Mongo document for future use. (for example, fine-tuning the other model with our data) <br />
 
 ### Media directory
+The third one is in the media directory. for now, We save a project called (MyTerraform) which is a Terraform template generated based on user requirements. so users can download it and use it.<be />
+surely we can save any static data in the `/media`.
 
-The third one is the media directory. For now, we save a project called (MyTerraform), which is a Terraform template generated based on user requirements, so users can download it and use it.
-Surely we can save any static data in the `/media`.
+![teramedia](https://github.com/user-attachments/assets/b8e10d83-68ac-4efc-b064-45f1d1a870dc)
 
 This is an example of a template generated in the `/media`
 
-The input is something like this:
+and the input is something like that
+
+![Screenshot from 2024-10-27 10-56-54](https://github.com/user-attachments/assets/63d1db07-2c25-4c10-a841-69a2c1235d9d)
+
+
 
 ### directory_generators
+This directory becomes updated when we trigger the template generation API. finally, It generates the MyTerraform directory based on user input which is a template.
 
-This directory gets updated when we trigger the template generation API. Finally, it generates the MyTerraform directory based on user input, which is a template.
 
 ## ToolChain
-
 1. Python
 2. Docker
-3. GPT-4-mini
+3. GPT-4o-mini
 4. FastAPI
 5. Helm
 
 ## Pre-requisites
-
 1. Python
 2. Docker
 
 ## How to use?
+execute `sh run.sh` in your terminal
 
-Execute `sh run.sh` in your terminal
-
-> [!WARNING]\
-> Do Not change the GPT model! Prompts have been developed for the GPT-4-mini model, and they can't be integrated with other GPT models. It can cause horrible incompatibility.
+> [!WARNING]  
+> Do Not change the GPT model! Prompts have been developed for the GPT-4-mini model and they can't be integrated with other GPT models. it can cause horrible incompatibility.
 
-## Run it locally on Kubernetes
+## Run it local on kubernetes
+If you want to run and use this chatbot app within your Kubernetes cluster, you can easily install it using the Helm chart provided in this repository
 
-If you want to run and use this chatbot app within your Kubernetes cluster, you can easily install it using the Helm chart provided in this repository:
-
-```
-helm install [RELEASE_NAME] helm/ -f helm/values.yaml
-```
-
-## Tests
-
-We have added unit tests to ensure the stability and reliability of the project.
-
-### Running Tests
-
-To run the tests, use the following command:
-
-```
-cd app
-pytest tests/
-```
-
-This command will execute all the test cases present in the `tests` folder. The tests include validation of the API endpoints, ensuring correct interactions with GPT services, and verifying that the generated outputs meet expected standards.
+    helm install [RELEASE_NAME] helm/ -f helm/values.yaml
 
 # Contributing
-
-Please read the [Contribution guide](https://github.com/abolfazl8131/devops-gpt/blob/master/CONTRIBUTING.md)
-
+please read the [Contribution guide](https://github.com/abolfazl8131/devops-gpt/blob/master/CONTRIBUTING.md)
 # Maintenance
-
-**[Abolfazl Andalib](https://github.com/abolfazl8131)** - [abolfazlandalib@gmail.com](mailto:abolfazlandalib@gmail.com)
-**[Mohammad Madanipour](https://github.com/mohammadll)** - [m.madanipourr@gmail.com](mailto:m.madanipourr@gmail.com)
+** [Abolfazl Andalib](https://github.com/abolfazl8131) - abolfazlandalib@gmail.com **<br />
+** [Mohammad Madanipour](https://github.com/mohammadll) - m.madanipourr@gmail.com **