Add files via upload

Author: 0xGrayy

CONTRIBUTING.md

@@ -1,2 +1,104 @@
-# malwareSniffer
-New Feature that using AI with (VirusTotal) to detect the malwares
+# 🕵️♂️ Malware Sniffer · [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+_A cybersecurity companion that sniffs out suspicious URLs with style_ 🔍✨
+
+<div align="center">
+  <img src="./assets/demo.gif" alt="Animated demo showing scanning process" width="800">
+  <p><em>Watch Malware Sniffer in action – from scanning to detailed report</em></p>
+</div>
+
+## 🌟 Why Malware Sniffer?
+
+In today's digital jungle, every click matters. Malware Sniffer is your trusty sidekick that:
+
+✅ **Instant Safety Check**: Scan any URL against 70+ security engines in real-time  
+✅ **Beautiful Reports**: Get clear, color-coded results with emoji storytelling  
+✅ **Developer Friendly**: Perfect for integrating into your security workflows  
+✅ **Zero Hassle**: Set up in 2 minutes with automatic progress tracking
+
+## 🚀 Getting Started
+
+### 📦 Installation
+
+```bash
+git clone https://github.com/0xGrayy/malwareSniffer.git
+cd malwareSniffer
+npm install
+```
+
+### 🔐 Configuration
+
+1. Get your free API key from [VirusTotal](https://www.virustotal.com)
+2. Create `.env` file:
+
+```env
+VIRUSTOTAL_API_KEY=your_actual_key_here
+```
+
+### 🕹️ Quick Start
+
+```typescript
+import { scanUrl } from "./virusTotal";
+
+// Be the cybersecurity hero your app needs 🦸
+scanUrl("https://your-url-here.com");
+```
+
+## 📊 What You'll See
+
+![Sample Scan Output](./assets/image-2.png)
+_Real scan results showing safety breakdown and detection details_
+
+## 🛠️ Tech Stack
+
+- **`axios`** → Smooth API communication
+- **`chalk`** → Terminal colors
+- **`cli-progress`** → That satisfying progress bar
+- **`figlet`** → Fancy ASCII art headers
+- **`moment`** → Precision timing metrics
+
+## 🖌️ Feature Highlights
+
+### 🎨 Visual Progress Tracking
+
+![Progress Bar Demo](./assets/image-1.png)
+_Watch the scan unfold with live ETA updates_
+
+### 🔍 Deep Analysis
+
+```markdown
+📌 Google Safebrowsing → 🛑 Malicious (blacklist)  
+📌 CRDF → ⚠️ Suspicious (heuristic)  
+📌 Quttera → ✅ Harmless (signature)
+```
+
+### 📈 Safety at a Glance
+
+```
+Safety Score: 92% 🟩🟩🟩🟩🟩🟩🟩🟩🟩🟥
+```
+
+## 🤝 Join the Security Squad
+
+We welcome contributors! Here's how to help:
+
+1. 🐛 **Report bugs** – Help us squash them!
+2. 💡 **Suggest features** – What's missing?
+3. 📖 **Improve docs** – Make things clearer
+4. 🧪 **Write tests** – Keep things reliable
+
+**First time contributing?** Check our [contribution guide](CONTRIBUTING.md)!
+
+## ⚠️ Important Notes
+
+- This tool **doesn't guarantee 100% safety** – always practice defense-in-depth
+- API rate limits apply – be kind to VirusTotal's servers
+- Keep your API key secret – treat it like your WiFi password 🔑
+
+## 📜 License
+
+MIT Licensed - Go build something secure! 🛡️
+
+---
+
+Made with ❤️ by [0xGrayy] · [Report Issue](https://github.com/0xGrayy/malwareSniffer/issues)