update README

Author: summerduck

README.md

@@ -1,2 +1,76 @@
-Alure report:
-$ allure serve test-report
+# API Test Automation Meme
+
+This repository contains a Python-based API test automation framework designed for testing the Meme Maker API. It utilizes tools such as [Locust](https://locust.io/) for load testing and [Allure](https://docs.qameta.io/allure/) for reporting.
+
+## Table of Contents
+
+- [Installation](#installation)
+- [Usage](#usage)
+- [Project Structure](#project-structure)
+
+## Installation
+
+1. **Clone the repository:**
+
+   ```bash
+   git clone https://github.com/Summerduck/api-test-automation-meme.git
+   cd api-test-automation-meme
+   ```
+
+2. **Create and activate a virtual environment:**
+
+   ```bash
+   python -m venv venv
+   source venv/bin/activate  # On Windows: venv\Scripts\activate
+   ```
+
+3. **Install the required dependencies:**
+
+   ```bash
+   pip install -r requirements.txt
+   ```
+
+## Usage
+
+1. **Run the tests:**
+
+   ```bash
+   pytest
+   ```
+
+2. **Generate and view the Allure report:**
+
+   ```bash
+   allure serve test-report
+   ```
+
+3. **Perform load testing with Locust:**
+
+   ```bash
+   locust -f locustfiles/your_locust_file.py
+   ```
+
+   Then, navigate to `http://localhost:8089` in your browser to start the load test.
+
+## Project Structure
+
+```plaintext
+api-test-automation-meme/
+├── data/
+│   └── ...                 # Test data files
+├── endpoints/
+│   └── ...                 # API endpoint definitions
+├── locustfiles/
+│   └── ...                 # Locust load testing scripts
+├── tests/
+│   └── ...                 # Test cases
+├── .gitignore
+├── LICENSE
+├── README.md
+├── api_documentation.md    # API documentation
+├── conftest.py             # Pytest configuration
+├── pytest.ini              # Pytest settings
+├── requirements.txt        # Python dependencies
+├── rlogger.py              # Custom logging configuration
+└── test-report/            # Allure test reports
+```