diff --git a/README.rst b/README.rst index 2635d1e..88aa16d 100644 --- a/README.rst +++ b/README.rst @@ -1,4 +1,52 @@ KickThemOut -=========== +============ `KickThemOut `_ - **Kick Devices Off Your Network** + +A tool to kick devices out of your network and enjoy all the bandwidth for yourself. +It allows you to select specific or all devices and ARP spoof them off your local area network. + +Compatible with Python 2.6 & 2.7. + +Authors: `Nikolaos Kamarinakis `_ & `David Schütz `_ + +.. image:: https://nikolaskama.me/... + +Installation +------------- + +You can download KickThemOut by cloning the `Git Repo `_ and simply installing its requirements:: + + $ git clone https://github.com/k4m4/kickthemout.git + + $ cd kickthemout + + $ pip install -r requirements.txt + +Demo +----- + +Here's a short demo: + +.. image:: https://nikolaskama.me/content/images/2017/01/kickthemout_asciinema.png + :target: https://asciinema.org/a/98200 + +(For more demos click `here `_) + +Disclaimer +----------- + +KickThemOut is provided as is under the MIT Licence (as stated below). +It is built for educational purposes only. If you choose to use it otherwise, the developers will not be held responsible. +In brief, do not use it with evil intent. + +License +-------- + +Copyright (c) 2017 by `Nikolaos Kamarinakis `_ & `David Schütz `_. All rights reserved. + +KickThemOut is under the terms of the `MIT License `_, following all clarifications stated in the `license file `_. + + +For more information head over to the `official project page `_. +You can also go ahead and email me anytime at **nikolaskam{at}gmail{dot}com** or David at **xdavid{at}protonmail{dot}com**. \ No newline at end of file diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..93b351f --- /dev/null +++ b/requirements.txt @@ -0,0 +1 @@ +scapy \ No newline at end of file