docs: update readme file

Author: nimisha-gj

.header.md

@@ -1,3 +1,3 @@
-# Main
+# terraform-aws-security-group
 
-asdfadsfas
+Terraform module to create security groups and rules

README.md

@@ -1,115 +1,43 @@
-# Terraform Module Template
+# terraform-aws-security-group
 
-This repository serves as a template for creating Terraform modules. It provides a structured approach to organizing and maintaining Terraform code, along with examples and best practices.
+Terraform module to create security groups and rules
 
-## Table of Contents
+## Requirements
 
-- [Prerequisites](#prerequisites)
-- [Usage](#usage)
-- [Examples](#examples)
-- [Module Structure](#module-structure)
+| Name | Version |
+|------|---------|
+| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >=  1.8.4 |
+| <a name="requirement_aws"></a> [aws](#requirement\_aws) | >= 5.51.0 |
 
-## Prerequisites
+## Providers
 
-Before you begin, ensure you have met the following requirements:
+| Name | Version |
+|------|---------|
+| <a name="provider_aws"></a> [aws](#provider\_aws) | 5.59.0 |
 
-1. [install terraform](https://developer.hashicorp.com/terraform/tutorials/aws-get-started/install-cli)
-2. [install pre-commit](https://pre-commit.com/#install)
-3. configure pre-commit: `pre-commit install`
-4. install required tools
-   - [tflint](https://github.com/terraform-linters/tflint)
-   - [terraform-docs](https://github.com/terraform-docs/terraform-docs)
+## Modules
 
-## Usage
+No modules.
 
-To use this template, clone the repository and customize it according to your module's requirements. Below is a quick start guide:
+## Resources
 
-1. **Clone the repository:**
+| Name | Type |
+|------|------|
+| [aws_security_group.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/security_group) | resource |
+| [aws_vpc.default](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/vpc) | data source |
 
-   ```sh
-   git clone https://github.com/your-username/terraform-module-template.git
-   cd terraform-module-template
-   ```
-2. **Customize the module:**
+## Inputs
 
-   - Update `main.tf`, `variables.tf`, `outputs.tf`, and `versions.tf` files as needed.
-   - Add your own resources and logic.
-3. **Run Terraform commands:**
+| Name | Description | Type | Default | Required |
+|------|-------------|------|---------|:--------:|
+| <a name="input_description"></a> [description](#input\_description) | (Optional, Forces new resource) Security group description. | `string` | `"Managed by Terraform"` | no |
+| <a name="input_name"></a> [name](#input\_name) | (Optional, Forces new resource) Name of the security group. | `string` | n/a | yes |
+| <a name="input_tags"></a> [tags](#input\_tags) | (Optional) Map of tags to assign to the resource. | `map(string)` | `{}` | no |
+| <a name="input_vpc_id"></a> [vpc\_id](#input\_vpc\_id) | (Optional, Forces new resource) VPC ID. | `string` | `null` | no |
 
-   ```sh
-   terraform init
-   terraform plan
-   terraform apply
-   ```
+## Outputs
 
-## Examples
-
-This repository includes example configurations to help you understand how to use the module:
-
-- **Complete Example:** Located in `examples/complete`
-
-  - Demonstrates a full-featured usage of the module.
-
-  ```sh
-  cd examples/complete
-  terraform init
-  terraform apply
-  ```
-- **Minimal Example:** Located in `examples/minimal`
-
-  - Shows a minimal configuration for using the module.
-
-  ```sh
-  cd examples/minimal
-  terraform init
-  terraform apply
-  ```
-
-## Module Structure
-
-The repository is organized as follows:
-
-```plaintext
-.
-├── .editorconfig
-├── examples
-│   ├── complete
-│   │   ├── main.tf
-│   │   ├── outputs.tf
-│   │   ├── provider.tf
-│   │   ├── README.md
-│   │   ├── variables.tf
-│   │   └── versions.tf
-│   └── minimal
-│       ├── main.tf
-│       ├── outputs.tf
-│       ├── provider.tf
-│       ├── README.md
-│       ├── variables.tf
-│       └── versions.tf
-├── .github
-│   └── workflows
-│       ├── documentation.yaml
-│       ├── pre-commit.yaml
-│       └── pr-title.yaml
-├── .gitignore
-├── main.tf
-├── modules
-│   └── sample-resource
-│       ├── main.tf
-│       ├── outputs.tf
-│       ├── variables.tf
-│       └── version.tf
-├── outputs.tf
-├── .pre-commit-config.yaml
-├── README.md
-├── .terraform-docs.yml
-├── tests
-│   ├── examples_minimal.tftest.hcl
-│   └── unit_tests.tftest.hcl
-├── .tflint.hcl
-├── variables.tf
-└── versions.tf
-```
-
-## Reference [Getoutline](https://infraspec.getoutline.com/doc/terraform-Xkko7xHwM5) Document for Conventions to follow in your module
+| Name | Description |
+|------|-------------|
+| <a name="output_security_group_arn"></a> [security\_group\_arn](#output\_security\_group\_arn) | The ARN of the security group |
+| <a name="output_security_group_id"></a> [security\_group\_id](#output\_security\_group\_id) | The ID of the security group |