Update README.md

README.md

@@ -17,3 +17,50 @@
   <img alt="Downloads" src="https://img.shields.io/github/downloads/slaxedu/WebArmor/total">
 
 </p>
+
+## Overview
+
+WebArmor is a powerful and user-friendly Python-based modular vulnerability scanner designed to enhance web application security. This tool aims to provide a comprehensive solution for identifying and mitigating potential security vulnerabilities in web applications.
+
+## Features
+
+- **Modular Architecture:** Easily extend and customize the scanner with modular components.
+- **Comprehensive Scanning:** Detect a wide range of vulnerabilities in web applications.
+- **User-Friendly Interface:** Simple command-line interface for efficient usage.
+- **Customizable:** Fine-tune the scan parameters based on your requirements.
+- **Detailed Reports:** Receive comprehensive reports outlining identified vulnerabilities.
+
+## Installation
+
+To get started with WebArmor, follow these simple steps:
+
+1. Clone the repository:
+
+```console
+git clone https://github.com/slaxedu/WebArmor.git
+```
+
+2. Install dependencies:
+
+```console
+pip install -r requirements.txt
+```
+
+3. Configure the `config.yaml` file with your domain and API keys.
+
+## Usage
+
+```console
+python main.py
+```
+
+For additional options and configurations, refer to the documentation.
+
+## Contributing
+We welcome contributions! Please check out our contribution guidelines for details.
+
+## License
+This project is licensed under the MIT License - see the `LICENSE` file for details.
+
+## Acknowledgments
+Special thanks to all our contributors who made this project possible.