UltyScan Documentation Overhaul

README.md

@@ -0,0 +1,51 @@
+# UltyScan
+## Professional Attack Surface Management Platform
+
+**UltyScan** is a next-generation automated information gathering and vulnerability scanning tool. It is designed to be the ultimate "button-pushing" solution for penetration testers and security professionals, automating the execution of dozens of powerful open-source tools to discover hidden assets and vulnerabilities.
+
+### 🚀 Key Features
+
+*   **Automated Recon**: Automatically gathers subdomains, IPs, and open ports.
+*   **Vulnerability Scanning**: Integrates with tools like Nikto, Zap, and OpenVAS to find weaknesses.
+*   **Multiple Modes**: From "Stealth" (low profile) to "Nuke" (full aggressive audit).
+*   **Visual Reports**: Generates HTML reports with all findings, including screenshots.
+*   **Workspace Management**: Keeps different client data separate and organized.
+
+---
+
+### 📚 Documentation
+
+For detailed instructions, please refer to our comprehensive guides:
+
+*   **[Installation Guide](docs/installation.md)**
+    *   Step-by-step setup for Kali Linux, Ubuntu, and Docker.
+*   **[Usage Guide](docs/usage.md)**
+    *   How to run scans, understand modes, and manage workspaces.
+*   **[Configuration Guide](docs/configuration.md)**
+    *   Customizing the scanner and setting up API keys (Shodan, Censys, etc.).
+
+---
+
+### ⚡ Quick Start
+
+1.  **Install**:
+    ```bash
+    git clone https://github.com/1N3/Sn1per
+    cd Sn1per
+    sudo bash install.sh
+    ```
+
+2.  **Run a Basic Scan**:
+    ```bash
+    sudo sniper -t example.com
+    ```
+
+3.  **View Results**:
+    Open the generated HTML report inside the `loot/workspace/` directory.
+
+---
+
+### NOTE
+This tool is for legal security auditing purposes only. Ensure you have permission to scan the target.
+
+*Based on the open-source Sn1per project.*