diff --git a/docs/index.md b/docs/index.md index 3b86b2f..51f0aad 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,17 +1,54 @@ -# ARP Spoofer +# ARP Spoofer 🌐 Welcome to the ARP Spoofer documentation. This tool provides advanced network packet analysis and ARP spoofing capabilities. -## Overview +## 📋 Overview ARP Spoofer is a Python-based tool that enables: -- Real-time packet capture and filtering -- Pattern-based traffic monitoring -- MAC address resolution -- Hostname detection - -## Quick Links -- [Installation Guide](installation.md) -- [Usage Guide](usage.md) -- [API Reference](api.md) -- [Contributing](contributing) \ No newline at end of file +- 🔍 Real-time packet capture and filtering +- 📊 Pattern-based traffic monitoring +- 🌐 MAC address resolution +- 🖥️ Hostname detection + +## ✨ Features + +### Network Analysis +- Real-time monitoring of network traffic +- Custom packet filtering options +- Detailed packet inspection +- Traffic pattern recognition + +### ARP Operations +- Smart gateway detection +- Target device mapping +- Traffic interception capabilities +- Packet manipulation tools + +### Reporting +- Multiple export formats (HTML, JSON, TXT) +- Interactive report generation +- Visual traffic analysis +- Custom data filtering + +## 📚 Documentation +- [Installation Guide](installation.md) - Setup and configuration +- [Usage Guide](usage.md) - Detailed usage instructions +- [API Reference](api.md) - Developer documentation +- [Contributing](contributing.md) - How to contribute + +## 🛡️ Security Notice + +This tool is intended for educational and authorized testing purposes only. Make sure to: +- Only use on networks you own or have explicit permission to test +- Follow local laws and regulations +- Be aware of potential security implications + +## 🤝 Support + +- Report issues on [GitHub](https://github.com/zeefxd/ARP-Spoofer/issues) +- Join our community discussions +- Check out the [contributing guidelines](contributing.md) + +## 📜 License + +This project is licensed under the MIT License - see the [LICENSE](https://github.com/zeefxd/ARP-Spoofer/blob/main/LICENSE) file for details. \ No newline at end of file