Skip to content

Commit f165a13

Browse files
committed
V1.1.8 - Updated ReadMe
1 parent bccb3d8 commit f165a13

File tree

2 files changed

+16
-5
lines changed

2 files changed

+16
-5
lines changed

β€ŽREADME.mdβ€Ž

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -37,13 +37,24 @@ VIRUSTOTAL_API_KEY=your_actual_key_here
3737

3838
### πŸ•ΉοΈ Quick Start
3939

40+
### for scanning a URL
41+
4042
```typescript
4143
import { scanUrl } from "./virusTotal";
4244

43-
// Be the cybersecurity hero your app needs 🦸
45+
// Example Usage for scanning a URL 🦸
4446
scanUrl("https://your-url-here.com");
4547
```
4648

49+
### for scanning a file
50+
51+
````typescript
52+
import { scanFile } from "./virusTotal";
53+
54+
// Example Usage for scanning a file 🦸
55+
scanFile("path/to/your/file.exe");
56+
```🦸
57+
4758
## πŸ“Š What You'll See
4859
4960
![Sample Scan Output](./assets/image-2.png)
@@ -67,10 +78,10 @@ _Watch the scan unfold with live ETA updates_
6778
### πŸ” Deep Analysis
6879
6980
```markdown
70-
πŸ“Œ Google Safebrowsing β†’ πŸ›‘ Malicious (blacklist)
71-
πŸ“Œ CRDF β†’ ⚠️ Suspicious (heuristic)
81+
πŸ“Œ Google Safebrowsing β†’ πŸ›‘ Malicious (blacklist)
82+
πŸ“Œ CRDF β†’ ⚠️ Suspicious (heuristic)
7283
πŸ“Œ Quttera β†’ βœ… Harmless (signature)
73-
```
84+
````
7485

7586
### πŸ“ˆ Safety at a Glance
7687

β€Žpackage.jsonβ€Ž

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
"start": "node dist/index.js",
99
"autobuild": "npx tsc -w",
1010
"autostart": "cls && npx tsc && node dist/index.js",
11-
"push": "git add . && git commit -m \"V1.1.8\" && git push",
11+
"push": "git add . && git commit -m \"V1.1.8 - Updated ReadMe\" && git push",
1212
"changelog": "git log --pretty=format:\"1. [**%s - `%h`**](https://github.com/0xGrayy/malwareSniffer/commit/%H)\" > CHANGELOG.md"
1313
},
1414
"keywords": [],

0 commit comments

Comments
Β (0)