From 341c68fe4dfc53832ad1d809cbd445caa8175286 Mon Sep 17 00:00:00 2001 From: Stone_Red <56473591+Stone-Red-Code@users.noreply.github.com> Date: Sat, 8 Jan 2022 16:39:28 +0100 Subject: [PATCH] Add usage guide and `Additional information` section --- README.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/README.md b/README.md index c10ea95..d70e511 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,26 @@ # FraudCapturer +> FraudCapturer is a app which analyzes the network trafic of your PC and blocks potential threats + +## Usage + +1. Download one of the [releases](https://github.com/Stone-Red-Code/FraudCapturer/releases) +1. Download and install [nmap](https://nmap.org/download.html) +1. (Not reqired but recommended) Get a [proxycheck.io](https://proxycheck.io/) api key +1. Start `FraudCapturer.exe` as administrator and pass the proxycheck api key to it if you have one +1. Select the network device you want the program to listen to + +## Additional information + +1. Why do i need to install nmap?\ + It is required because FraudCapturer uses it to monitor incoming and outgoing packets.\ + FraudCapturer uses the [sharppcap](https://github.com/dotpcap/sharppcap) ([license](https://github.com/dotpcap/sharppcap/blob/master/LICENSE)) library to communicate with nmap. + +1. Does FraudCapturer send all packet contents to the APIs?\ + No, only the required information (IP addresses/domains) and the PC name to identify the device are sent to the APIs. + +1. How does FraudCapturer determine which IP addresses or domains are potential threats?\ + It uses the [proxycheck.io](https://proxycheck.io/) and [Anti-Fish](https://anti-fish.bitflow.dev/) APIs. + +1. Why does FraudCapturer need administrator rights?\ + FraudCapturer needs them because it uses the Windows firewall to block IP addresses.