From f9d5571eff9f67ae5df23edd7ed1032f9843a388 Mon Sep 17 00:00:00 2001 From: bitbrute Date: Tue, 17 Sep 2019 22:02:33 +0200 Subject: [PATCH] Update README --- README.md | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index b1ea1ac..2399219 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,10 @@ [![Open Source Love](https://badges.frapsoft.com/os/v3/open-source.svg?v=102)](https://github.com/ellerbrock/open-source-badge/) A tool to limit the bandwidth (upload/download) of devices connected to your network without physical or administrative access.
-```evillimiter``` employs [ARP spoofing](https://en.wikipedia.org/wiki/ARP_spoofing) and [traffic shaping](https://en.wikipedia.org/wiki/Traffic_shaping) to throttle the bandwidth of hosts on the network. This is explained in detail below. +```evillimiter``` employs [ARP spoofing](https://en.wikipedia.org/wiki/ARP_spoofing) and [traffic shaping](https://en.wikipedia.org/wiki/Traffic_shaping) to throttle the bandwidth of hosts on the network. + +**Searching for a Windows-compatible version?**
+Check out the open-source alternative [EvilLimiter for Windows](https://github.com/bitbrute/evillimiter-windows). ## Requirements - Linux distribution @@ -49,10 +52,10 @@ Type ```evillimiter``` or ```python3 bin/evillimiter``` to run the tool. | Command | Explanation | | ------- | ----------- | -| ```scan (--range [IP Range])``` | Scans your network for online hosts. One of the first things to do after start. For example: ```scan --range 192.168.178.1-192.168.178.40``` or just ```scan``` to scan the entire subnet. -| ```hosts``` | Displays all the hosts/devices previously scanned and basic information. Shows ID for each host that is required for interaction. -| ```limit [ID1,ID2,...] [Rate]``` | Limits bandwidth of host(s) associated to specified ID. Rate determines the internet speed.
Valid rates: ```bit```, ```kbit```, ```mbit```, ```gbit```, ```tbit```
For example: ```limit 4,5,6 200kbit``` or ```limit all 1gbit``` -| ```block [ID1,ID2,...]``` | Blocks internet connection of host(s) associated to specified ID. +| ```scan (--range [IP Range])``` | Scans your network for online hosts. One of the first things to do after start.
```--range``` lets you specify a custom IP range.
For example: ```scan --range 192.168.178.1-192.168.178.40``` or just ```scan``` to scan the entire subnet. +| ```hosts (--force)``` | Displays all the hosts/devices previously scanned and basic information. Shows ID for each host that is required for interaction.
```--force``` forces the table to be shown, even when it doesn't fit the terminal. +| ```limit [ID1,ID2,...] [Rate] (--upload) (--download)``` | Limits bandwidth of host(s) associated to specified ID. Rate determines the internet speed.
```--upload``` limits outgoing traffic only.
```--download``` limits incoming traffic only.
Valid rates: ```bit```, ```kbit```, ```mbit```, ```gbit```
For example: ```limit 4,5,6 200kbit``` or ```limit all 1gbit``` +| ```block [ID1,ID2,...] (--upload) (--download)``` | Blocks internet connection of host(s) associated to specified ID.
```--upload``` limits outgoing traffic only
```--download``` limits incoming traffic only. | ```free [ID1,ID2,...]``` | Unlimits/Unblocks host(s) associated to specified ID. Removes all further restrictions. | ```add [IP] (--mac [MAC])``` | Adds custom host to host list. MAC-Address will be resolved automatically or can be specified manually.
For example: ```add 192.168.178.24``` or ```add 192.168.1.50 --mac 1c:fc:bc:2d:a6:37``` | ```clear``` | Clears the terminal window.