modified readme

Author: hanimao

README.md

@@ -2,32 +2,13 @@
 
 This repository deploys a Node.js WebAPI app and a SQL Server database on AWS. It also includes a CI/CD pipeline using GitHub Actions to automate deployment of code changes to the API. The infrastructure is designed to be modular, scalable, and extendable for future enhancements. Lambda was used to host the Node.js WebAPI and the API Gateway exposes HTTP endpoints for the Lambda function. 
 
+---
 
+# Key Features 
 
-# Table of Contents 
-
-1. [Architecture Diagram](#architecture-diagram) 
-2. [Workflow](#workflow) 
-3. [Getting Started](#getting-started)
-4. [Terraform Infrastructure](#terraform-infrastructure)
-
-
-
-# Architecture Diagram 
-
-![architecture diagram](<images/lambda.drawio.svg>)
-
-![serverless](images/app.png)
-
-![route2](images/route1.png)
-
-
-# Workflow 
 
 This project demonstrates a **serverless Node.js WebAPI** deployed on AWS using **Terraform**.  
 
-Running `terraform apply` provisions:
-
 1. **S3 Bucket**
    - Stores the deployment ZIP (`deployment.zip`) for Lambda
 2. **AWS Lambda Function**
@@ -45,6 +26,54 @@ Running `terraform apply` provisions:
    - updates Lambda automatically on code changes 
 
 
+---
+
+# Directory Structure
+
+The AWS infrastructure was organised into reusable modules to build the infrastructure and this approach promotes the DRY (Don't Repeat Yourself) principle and makes your code scalable and maintainable. Terraform was used to provision the infrastructure, with the state backend securely hosted on AWS S3, enabling reliable tracking. 
+
+
+
+```text
+
+serverless/
+├── infra/
+│   ├── environments/
+│   │   ├── dev/
+│   │   │   ├── backend.tf
+│   │   │   ├── component.tf
+│   │   │   ├── main.tf
+│   │   │   ├── oidc.tf
+│   │   │   ├── outputs.tf
+│   │   │   └── variables.tf
+│   │   └── prod/
+│   └── modules/
+│       ├── api/
+│       ├── database/
+│       ├── lambda/
+│       └── networking/
+├── src/
+│   └── handler/
+│       ├── node_modules/
+│       ├── index.js
+│       ├── package-lock.json
+│       └── package.json
+├── .gitignore
+├── .pre-commit-config
+└── README.md
+   
+```
+
+---
+
+# Architecture  
+
+![architecture diagram](<images/lambda.drawio.svg>)
+
+---
+
+# Workflow
+
 ### API Routes
 
 | Route       | Method | Description |
@@ -78,8 +107,9 @@ Running `terraform apply` provisions:
 7. Lambda executes a test query
 8. API Gateway returns the JSON response to the client.
 
+---
 
-### How code changes are deployed (CI/CD workflow)
+# CI/CD Pipeline
 
 When application code is modified and pushed to GitHub, the CI/CD pipeline automatically updates the Lambda function with the latest version of the code. The process works as follows:
 
@@ -92,64 +122,11 @@ When application code is modified and pushed to GitHub, the CI/CD pipeline autom
 5. After the ZIP is uploaded, the workflow calls AWS to update the Lambda function’s code, instructing Lambda to pull the latest ZIP from S3.
 6. Lambda immediately switches to the new code, meaning all API Gateway requests (`/` and `/health`) begin using the updated Lambda logic without any downtime.
 
+---
 
-# Getting Started
-
-### Prerequisites 
-
-Before using this repository, ensure you have the following installed and configured on your machine:
-
-![Terraform](https://img.shields.io/badge/terraform-%235835CC.svg?style=for-the-badge&logo=terraform&logoColor=white)
-![GitHub Actions](https://img.shields.io/badge/github%20actions-%232671E5.svg?style=for-the-badge&logo=githubactions&logoColor=white)
-![GitHub](https://img.shields.io/badge/github-%23121011.svg?style=for-the-badge&logo=github&logoColor=white)
-![AWS](https://img.shields.io/badge/AWS-%23FF9900.svg?style=for-the-badge&logo=amazon-aws&logoColor=white)
-
- ### Configure AWS CLI
-
-```bash
-$ aws configure
-AWS Access Key ID [None]: accesskey
-AWS Secret Access Key [None]: secretkey
-Default region name [None]: your region
-Default output format [None]:
-```
-
+### **Here's what it will look like**
 
-# Terraform Infrastructure 
-
-The AWS infrastructure was organised into reusable modules to build the infrastructure and this approach promotes the DRY (Don't Repeat Yourself) principle and makes your code scalable and maintainable. Terraform was used to provision the infrastructure, with the state backend securely hosted on AWS S3, enabling reliable tracking. 
-
-
-### Terraform directory 
-
-```text
-
-serverless/
-├── infra/
-│   ├── environments/
-│   │   ├── dev/
-│   │   │   ├── backend.tf
-│   │   │   ├── component.tf
-│   │   │   ├── main.tf
-│   │   │   ├── oidc.tf
-│   │   │   ├── outputs.tf
-│   │   │   └── variables.tf
-│   │   └── prod/
-│   └── modules/
-│       ├── api/
-│       ├── database/
-│       ├── lambda/
-│       └── networking/
-├── src/
-│   └── handler/
-│       ├── node_modules/
-│       ├── index.js
-│       ├── package-lock.json
-│       └── package.json
-├── .gitignore
-├── .pre-commit-config
-└── README.md
-   
-```
 
+![serverless](images/app.png)
 
+![route2](images/route1.png)