From 29394a8d2fb2589c2f576e5f42905f38b8b5f3b5 Mon Sep 17 00:00:00 2001
From: msjid <majidgeravand@gfuse.it>
Date: Fri, 28 Aug 2026 19:25:45 +0200
Subject: [PATCH] Improve README with comprehensive documentation

- Add clear project description and prerequisites
- Include project structure and quick start guide
- Document features, configuration, and outputs
- Add cleanup instructions and operational notes
- Fix typos and formatting

Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01FXWthfA87zaqDnP1N8DU7M
---
 README.md | 94 +++++++++++++++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 92 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 00a8243..bf3252b 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,93 @@
-# teraform_aws
+# Terraform AWS EC2 Deployment
 
-A simple example of deploying an EC2 in AWS while injecting installation commends during setup
\ No newline at end of file
+A Terraform project that automates the deployment of EC2 instances on AWS with custom initialization scripts. This showcases Infrastructure as Code best practices using Terraform to provision and configure cloud resources.
+
+## Prerequisites
+
+- **Terraform** >= 1.0 (download from [terraform.io](https://www.terraform.io/downloads.html))
+- **AWS Account** with appropriate IAM permissions
+- **AWS CLI** configured with valid credentials
+- Basic understanding of Terraform and AWS EC2
+
+## Project Structure
+
+```
+.
+├── README.md
+├── main.tf              # Primary Terraform configuration
+├── variables.tf         # Variable definitions
+├── outputs.tf          # Output values
+└── terraform.tfvars    # Variable values (create this file)
+```
+
+## Quick Start
+
+1. **Clone or navigate to the project directory**
+   ```bash
+   cd teraform_aws
+   ```
+
+2. **Initialize Terraform**
+   ```bash
+   terraform init
+   ```
+
+3. **Create terraform.tfvars** with your configuration:
+   ```hcl
+   aws_region = "us-east-1"
+   instance_type = "t2.micro"
+   # Add other variables as needed
+   ```
+
+4. **Plan the deployment**
+   ```bash
+   terraform plan
+   ```
+
+5. **Apply the configuration**
+   ```bash
+   terraform apply
+   ```
+
+6. **Retrieve outputs**
+   ```bash
+   terraform output
+   ```
+
+## Features
+
+- Automated EC2 instance provisioning
+- Custom initialization scripts (user data) for post-launch configuration
+- Configurable instance types and regions
+- Security group management
+- Infrastructure state management with Terraform
+
+## Configuration
+
+Edit `terraform.tfvars` to customize:
+- AWS region
+- Instance type
+- Number of instances
+- Custom initialization commands
+- Security group rules
+
+## Outputs
+
+After successful deployment, Terraform will output:
+- EC2 instance IDs
+- Public/Private IP addresses
+- Security group information
+
+## Cleanup
+
+To destroy all resources:
+```bash
+terraform destroy
+```
+
+## Notes
+
+- Ensure your AWS credentials are properly configured before running Terraform
+- Review the plan output before applying changes
+- Some resources may incur AWS charges
+- Use appropriate AMI IDs for your chosen region
\ No newline at end of file