From 670d1a6d887a0ac4152a421bbf3f95576d0a781d Mon Sep 17 00:00:00 2001
From: nudgebee-bot <bot@nudgebee.com>
Date: Tue, 21 Apr 2026 07:34:35 +0000
Subject: [PATCH] docs: update README.md with Project Documentation and Create
 PR
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

# docs: update README.md with Project Documentation and Create PR

## Description
The README.md file was updated to provide a comprehensive overview of the project. The update includes a project description, its purpose, key features, and detailed usage instructions. The project is identified as a Playwright-based automated testing suite for web applications, featuring both positive and negative test cases, visual testing through screenshots, and CI/CD integration. Usage instructions cover installation, running tests in various modes, and configuring necessary environment variables.

## Changes
- **README.md**:
    - Added a detailed project description and purpose.
    - Outlined key features including automated login tests and visual testing.
    - Provided comprehensive usage instructions (Prerequisites, Installation, Running Tests).
    - Documented required environment variables for secure configuration.

## Original Error/Logs

<details>
<summary>Click to expand the original error that triggered this fix</summary>

```
Update the README.md file to include a project description, purpose, features, and usage instructions. Create a pull request against the 'main' branch.
```

</details>

---

🤖 **This PR was automatically generated by [NudgeBee](https://nudgebee.com) AI coding agent**

*Powered by AI-driven code analysis and automated fix generation*

View Detailed **[Nubi Conversation](https://dev.nudgebee.pollux.in/ask-nudgebee?accountId=148d59fa-af70-470d-b3e0-bbc3f6fa4e67&session_id=)**
---
 README.md | 69 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 69 insertions(+)

diff --git a/README.md b/README.md
index 7d682b2..8891145 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,70 @@
+# Testing Purpose
+
 ![Playwright CI/CD](https://github.com/VanshikaR7/Testing_Purpose/actions/workflows/playwright.yml/badge.svg)
+
+## Project Description
+This repository is a Playwright-based automated testing suite designed for web applications. It serves as a demonstration and practice environment for end-to-end (E2E) testing, covering various scenarios including login flows and UI validation.
+
+## Purpose
+The primary purpose of this project is to showcase automated testing capabilities using Playwright. It includes:
+- Implementation of positive and negative test cases.
+- Handling of environment variables for secure data management.
+- Capturing and storing screenshots for visual verification.
+- Integration with CI/CD pipelines (GitHub Actions).
+
+## Features
+- **Automated Login Tests**: Includes both successful login scenarios and negative test cases with error message validation.
+- **Visual Testing**: Captures element-specific and full-page screenshots during test execution.
+- **Flexible Execution**: Supports running tests in headed mode, UI mode, and headless mode for CI environments.
+- **Environment Configuration**: Uses environment variables (`BASE_URL`, `USERNAME`, `PASSWORD`) to allow testing across different environments without hardcoding credentials.
+
+## Usage Instructions
+
+### Prerequisites
+- Node.js installed on your machine.
+- npm (Node Package Manager).
+
+### Installation
+1. Clone the repository:
+   ```bash
+   git clone https://github.com/VanshikaR7/Testing_Purpose.git
+   cd Testing_Purpose
+   ```
+2. Install dependencies:
+   ```bash
+   npm install
+   ```
+3. Install Playwright browsers:
+   ```bash
+   npx playwright install
+   ```
+
+### Running Tests
+- **Run all tests**:
+  ```bash
+  npm test
+  ```
+- **Run tests in Headed mode**:
+  ```bash
+  npm run test:headed
+  ```
+- **Run tests in UI mode**:
+  ```bash
+  npm run test:ui
+  ```
+- **Run a specific test file**:
+  ```bash
+  npm run test:file -- tests/Positive_tests/02_Loginpage.spec.ts
+  ```
+
+### Environment Variables
+For tests that require authentication, ensure the following environment variables are set:
+- `BASE_URL`: The URL of the application under test.
+- `USERNAME`: The login username.
+- `PASSWORD`: The login password.
+
+Example:
+```bash
+BASE_URL=https://example.com USERNAME=myuser PASSWORD=mypass npm test
+```
+