Skip to content

Commit

Permalink
docs: update index.md
Browse files Browse the repository at this point in the history
  • Loading branch information
zeefxd committed Dec 4, 2024
1 parent 9e5befc commit d3722ed
Showing 1 changed file with 49 additions and 12 deletions.
61 changes: 49 additions & 12 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -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)
- 🔍 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.

0 comments on commit d3722ed

Please sign in to comment.