Update readme

Genbox · Oct 29, 2022 · eac9f4b · eac9f4b
1 parent 4a0c43d
commit eac9f4b
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 17 deletions.
diff --git a/README.markdown b/README.markdown
diff --git a/README.md b/README.md
@@ -0,0 +1,17 @@
+# VirusTotal Context Menu - Right click on a file to scan it.
+
+### Features
+* Based on VirusTotalNet (https://github.com/Genbox/VirusTotalNet) to get reports and scanning the files.
+
+### How to use
+1. Download the latest release from https://github.com/Genbox/VirusTotalContextMenu/releases
+2. Unpack the ZIP file to where you want the application. It is portable.
+3. Get an API key from VirusTotal.com and put it inside appsettings.json
+4. Register the context menu handler by right-clicking the VirusTotalContextMenu.exe file and select "Run as Administrator"
+5. Now you can right-click any file an select "VT Scan" to scan it using VirusTotal
+
+### Notes
+* You can use VirusTotalContextMenu.exe "--register" and "--unregister" command line arguments as well.
+* VirusTotal limits the number of requests to 4 per minute.
+* VirusTotal also limits the file size to 32 MB.
+* It sends your file to VirusTotal if they don't already have it.