Merge pull request #9 from ramjangatisetty/feature/githubworkflowwithdocker

Updated the format in README.md file

Author: ramjangatisetty

README.md

@@ -30,64 +30,68 @@ Supports cross-browser testing, rich reporting with **Allure**, Dockerized execu
 - ✅ GitHub Pages publishing for Allure reports
 
 ---
-🐞 Debugging Playwright Tests in VS Code
-  You can debug your Playwright tests using VS Code's built-in debugger and the provided launch.json configuration.
-
-  Example launch.json configuration:
-  
-  ```json
-  {
-    "type": "node",
-    "request": "launch",
-    "name": "Debug Playwright Test",
-    "program": "${workspaceFolder}/node_modules/@playwright/test/cli.js",
-    "args": [
-      "test",
-      "--headed",
-      "--project=chromium"
-    ],
-    "env": {
-      "TAG": "@smoke",
-      "BROWSER": "chromium",
-      "WORKERS": "1",
-      "RETRIES": "1",
-      "TEST_ENV": "qa1"
-    },
-    "console": "integratedTerminal",
-    "internalConsoleOptions": "openOnSessionStart"
-  }
-  ```
-
-  How to Use
-    Open your project in VS Code.
-    Set breakpoints in your test or page files.
-    Go to the Run & Debug panel (left sidebar).
-    Select Debug Playwright Test from the dropdown.
-    Click the green play button (▶️) to start debugging.
-    The browser will open in headed mode, and you can step through your code, inspect variables, and use all VS Code debugging features.
-
-  You can customize the environment variables and arguments as needed for your test run.
-  For more details, see VS Code Debugging Documentation.
-
-🐞 Debugging Tests with Playwright Debugger
-  You can debug your Playwright tests using the built-in Playwright Inspector or VS Code debugger. The project provides a convenient script for running tests in debug mode with environment variables pre-set.
-
-  Using the Debug Script
+
+## 🐞 Debugging Playwright Tests in VS Code
+
+You can debug your Playwright tests using VS Code's built-in debugger and the provided launch.json configuration.
+Example launch.json configuration:
+
+```json
+{
+  "type": "node",
+  "request": "launch",
+  "name": "Debug Playwright Test",
+  "program": "${workspaceFolder}/node_modules/@playwright/test/cli.js",
+  "args": ["test", "--headed", "--project=chromium"],
+  "env": {
+    "TAG": "@smoke",
+    "BROWSER": "chromium",
+    "WORKERS": "1",
+    "RETRIES": "1",
+    "TEST_ENV": "qa1"
+  },
+  "console": "integratedTerminal",
+  "internalConsoleOptions": "openOnSessionStart"
+}
+```
+
+### ▶️ How to Use
+
+Open your project in VS Code.
+Set breakpoints in your test or page files.
+Go to the Run & Debug panel (left sidebar).
+Select Debug Playwright Test from the dropdown.
+Click the green play button (▶️) to start debugging.
+The browser will open in headed mode, and you can step through your code, inspect variables, and use all VS Code debugging features.
+
+You can customize the environment variables and arguments as needed for your test run.
+For more details, see VS Code Debugging Documentation.
+
+---
+
+## 🐞 Debugging Tests with Playwright Debugger
+
+You can debug your Playwright tests using the built-in Playwright Inspector or VS Code debugger. The project provides a convenient script for running tests in debug mode with environment variables pre-set.
+
+### Using the Debug Script
+
   To run tests in debug mode with your environment settings, use:
     npm run test:env:debug -- [test-file-or-pattern] --debug
-    test:env:debug is the script defined under package.json file
-    This command sets the following variables:
-      TAG='@smoke' BROWSER='chromium' WORKERS=2 RETRIES=1 TEST_ENV='qa1'
-    The --debug flag opens the Playwright Inspector for interactive debugging.
-    Example
-      npm run test:env:debug -- tests/login.spec.ts --debug
-    What Happens
+  test:env:debug is the script defined under package.json file
+  This command sets the following variables:
+  TAG='@smoke' BROWSER='chromium' WORKERS=2 RETRIES=1 TEST_ENV='qa1'
+  The --debug flag opens the Playwright Inspector for interactive debugging.
+  Example
+    npm run test:env:debug -- tests/login.spec.ts --debug
+  What Happens
     The script runs Playwright tests with your specified environment.
     The Playwright Inspector UI will open, allowing you to step through your tests, inspect selectors, and interact with the browser.
   Tips
-    You can pass any test file or pattern after -- to target specific tests.
-    Use breakpoints in your test code or add await page.pause() to pause execution at a specific point.
-    Add this section to your README.md to help contributors debug tests using your custom script and Playwright’s debugging tools. Let me know if you want this inserted automatically!
+  You can pass any test file or pattern after -- to target specific tests.
+  Use breakpoints in your test code or add await page.pause() to pause execution at a specific point.
+  Add this section to your README.md to help contributors debug tests using your custom script and Playwright’s debugging tools. Let me know if you want this inserted automatically!
+
+  ---
 
 ## 🧪 Running Tests Locally
 
@@ -139,23 +143,6 @@ docker run --rm -v $(pwd)/allure-report:/app/allure-report my-playwright-runner
 }
 ```
 
----
-
-## 📂 Project Structure
-
-e2e-playwright-framework/
-├── tests/ # Test specs
-├── pages/ # Page Object Models
-├── utils/ # Custom utilities
-├── storage/ # Session files
-├── allure-results/ # Allure raw data
-├── allure-report/ # Allure HTML reports
-├── playwright.config.ts # Playwright test config
-├── DockerFile.playwright # Dockerfile for CI/CD
-├── .github/workflows/ # GitHub Actions workflows
-
-
-
 ## ✅ GitHub Actions CI/CD
 
 This project uses **GitHub Actions** to automate test execution and reporting.
@@ -169,7 +156,6 @@ This project uses **GitHub Actions** to automate test execution and reporting.
 ### 📁 Workflow Location
 
 .github/workflows/playwright.yml
-```
 
 ### 🐳 Docker in CI
 
@@ -192,7 +178,7 @@ This project uses **GitHub Actions** to automate test execution and reporting.
 > 🚀 Automated Playwright tests with integrated Allure reporting and GitHub Pages hosting.
 
 - Allure HTML reports are published to GitHub Pages after each CI run.
-- Access the latest report [here](https://ramjangatisetty.github.io/e2e-playwright-typescript-framework-template/).
+- Access the latest Allure report [on GitHub Pages](https://ramjangatisetty.github.io/e2e-playwright-typescript-framework-template/).
 
 ---