Update README.md

README.md

@@ -1,2 +1,56 @@
-# web-performance-reporter
-This project is a tool for analyzing the performance of web pages. Given a CSV of URLs, it uses Google's Lighthouse tool to generate scores for metrics like performance, accessibility, and SEO. The results are then output to a CSV file for easy analysis and comparison.
+# Web Performance Reporter
+![image](https://github.com/sh-alireza/web-performance-reporter/assets/75808544/ccdec2be-3adc-4ae2-9085-3577ad78317a)
+
+## Description
+The Web Performance Reporter is a simple yet powerful tool for website developers seeking to improve website performance. Leveraging the power of Lighthouse through the use of the [lighthouse-python-plus](https://github.com/sh-alireza/lighthouse-python-plus) package. The tool is designed to handle multiple requests to the API with ease, thanks to the use of Celery and RabbitMQ. 
+Also this tool can compare the performance of old and new hosts in a single CSV file. This feature makes it easy for developers to see the impact of any changes made to a website and identify areas that require further optimization.
+
+## Usage
+
+```bash
+- git clone https://github.com/sh-alireza/web-performance-reporter.git
+- cd web-performance-reporter
+- docker-compose up --build
+```
+
+### lighthouse app:
+![image](https://github.com/sh-alireza/web-performance-reporter/assets/75808544/6b5b1792-6a60-4319-a29e-1fd0e8f4d0db)
+
+- host_1 (required): The primary host for performance testing.
+
+- host_2 (optional): Secondary host for comparison with the primary host. Use a new host to compare with the old one.
+
+- priority (optional): Priority check for URLs in the CSV input. If left empty, all URLs will be checked. To check only specific URLs based on their priority value, add the priority value to this parameter.
+
+- form_factor (optional): Choose either "mobile" or "desktop" as the form factor for Lighthouse. The default value is "mobile".
+
+- speed (optional): This parameter sets the Lighthouse environment, including throttling and internet speed. The default settings are based on those found on [pagespeed](https://pagespeed.web.dev/), but you can change them by modifying the MORE_SETTINGS variable in main.py. The available options for speed are "normal", "slow-4g", and leaving it blank for using only Lighthouse's default settings. "Normal" applies all settings with throttling method set to "provided", and "slow-4g" applies all settings with throttling method set to "simulate".
+
+- quiet (optional): Set this parameter to True for debugging purposes when you want to see the logs written by Lighthouse. The default value is False.
+
+- loop (optional): Set this parameter to the number of times you want to run Lighthouse for each URL. For example, if you set it to 3, Lighthouse will run 3 times and return the mean of the results.
+
+- input_urls (required): This parameter requires a CSV file in the format shown in the [sample_inputs](sample_inputs.csv) file in this repository.
+
+### output:
+![image](https://github.com/sh-alireza/web-performance-reporter/assets/75808544/2d6adbc0-d79a-4e12-ae76-c59c178f971e)
+
+The output will consist of a task ID and a static output file link.
+
+### status:
+![image](https://github.com/sh-alireza/web-performance-reporter/assets/75808544/5a78657e-17f6-47d1-b60e-a4eb44a18bbb)
+
+You can use the provided task ID to check its status, which can be pending, failed, or successful.
+
+### pending tasks:
+![image](https://github.com/sh-alireza/web-performance-reporter/assets/75808544/1bd16d8b-80a5-4658-b97e-fd929c1c2473)
+
+You can view all pending tasks and their corresponding task IDs.
+
+### delete task:
+![image](https://github.com/sh-alireza/web-performance-reporter/assets/75808544/b7dc2187-ca7c-494f-9077-f76ac50c83e2)
+
+You can delete a task using its corresponding task ID.
+
+## Changes
+[You can find all changes in CHANGELOG!](CHANGELOG.md)