From cc7587173ad07f65cce8df6d441bb8af3d9cb534 Mon Sep 17 00:00:00 2001
From: paveltovchigrechko <pavel.tovchigrecko.1988@gmail.com>
Date: Mon, 3 Mar 2025 10:42:10 +0100
Subject: [PATCH] Update README

---
 README.md | 86 ++++++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 85 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 760b473..6032991 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,85 @@
-# guide-pytest-playwright-video
\ No newline at end of file
+# Integrating video in Allure Report with Pytest and Playwright
+
+This repository contains code example for integrating videos in Allure Report with Pytest and Playwright. You can find the original documentation:
+
+- [English version](https://allurereport.org/docs/guides/pytest-playwright-video/)
+- [Spanish version](https://allurereport.org/es/docs/guides/pytest-playwright-video/)
+
+## Preparation
+
+1. Make sure you have installed:
+
+    - [Python](https://www.python.org/downloads/) version 3.9 or higher
+    - [Allure Report](https://allurereport.org/docs/install/)
+
+1. Clone the repository via HTTPS:
+
+    ```shell
+    git clone https://github.com/allure-examples/guide-pytest-playwright-video.git
+    ```
+
+    or SSH:
+
+    ```shell
+    git clone git@github.com:allure-examples/guide-pytest-playwright-video.git
+    ```
+
+1. In the shell of your choice, navigate to the repository directory:
+
+    ```shell
+    cd path/to/guide-pytest-selenium-screenshots
+    ```
+
+## Run tests
+
+The repository provides with automatic scripts that install the virtual environment, necessary packages, and run the tests. Run the script correspondind to your operating system. For Linux and MacOS:
+
+```
+./run.sh
+```
+
+For OS Windows:
+
+```shell
+.\run.bat
+```
+
+Alternatively:
+1. Create a Python virtual environment manually:
+
+    ```shell
+    python -m venv venv
+    ```
+
+1. Activate the virtual environment (Linux and MacOS):
+
+    ```shell
+    source venv/bin/activate
+    ```
+
+    OS Windows:
+    ```powershell
+    .\venv\Scripts\Activate.ps1
+    ```
+
+1. Install the packages used in the project:
+
+    ```
+    pip install -r requirements.txt
+    ```
+
+1. Run Pytest:
+
+    ```
+    pytest
+    ```
+
+## Run Allure Report
+
+1. To start a local Allure Report server, in the project root directory run:
+
+    ```shell
+    allure serve -p <port-of-your-choice>
+    ```
+
+1. Browse the Allure Report page on `http://127.0.0.1:<port-of-your-choice>`