From a44ef95a3f41f67f980a623041193344989cb441 Mon Sep 17 00:00:00 2001
From: Haddougui Hamza <163064474+haddouguihamza@users.noreply.github.com>
Date: Wed, 2 Apr 2025 11:52:59 +0000
Subject: [PATCH] docs: update README with project details and contribution
 guide

Update README file content using a generated response from Github Copilot that describes the repository's features, prerequisites, how to get started, technologies used to develop the project codebase, topics to improve this repository discoverability on Github, contribution and its main purpose

Signed-off-by: Haddougui Hamza <163064474+haddouguihamza@users.noreply.github.com>
---
 README.md | 71 ++++++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 70 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index fef7f67..666215e 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,71 @@
 # Struts6-Springboot
-Create Spring web application middle-tier using Spring boot and integration of third party web framework Struts handling the presentation layer. Project codebase was created via Spring starter project template in Eclipse IDE.
+
+## Description
+
+This repository contains a Spring Boot demo application built using the Spring framework and integrated with the Struts MVC web framework for the presentation layer.
+
+## Features
+
+- Integration of Struts6 MVC with Spring Boot
+- Example of a well-structured Spring Boot application
+- Demonstrates how to use Struts for the presentation layer while leveraging Spring Boot for backend services
+
+## Prerequisites
+
+- Java Development Kit (JDK) 8 or higher
+- Maven 3.6.0 or higher
+- An IDE (e.g., IntelliJ IDEA, Eclipse)
+
+## Getting Started
+
+### Clone the Repository
+
+```bash
+git clone https://github.com/haddouguihamza/Struts6-Springboot.git
+cd Struts6-Springboot
+```
+
+### Build the Project
+
+```bash
+mvn clean install
+```
+
+### Run the Application
+
+```bash
+mvn spring-boot:run
+```
+
+### Access the Application
+
+Once the application is running, you can access it at `http://localhost:8080`.
+
+## Project Structure
+
+- `src/main/java`: Contains the Java source code
+- `src/main/resources`: Contains the application configuration files
+- `src/main/webapp`: Contains the web application files (JSPs, static resources)
+
+## Technologies Used
+
+- Java
+- Spring Boot
+- Struts6 MVC
+- Maven
+
+## Contributing
+
+Contributions are welcome! Please fork the repository and create a pull request with your changes.
+
+## License
+
+This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
+
+## Contact
+
+For any questions or suggestions, please feel free to reach out.
+
+---
+
+Feel free to customize this README further based on additional details or specific requirements for the repository.