mirror of
https://github.com/k4m4/kickthemout.git
synced 2024-11-25 22:44:25 +01:00
Update README.rst & Create requirements.txt
This commit is contained in:
parent
9473bd66bc
commit
523992d33c
50
README.rst
50
README.rst
@ -1,4 +1,52 @@
|
|||||||
KickThemOut
|
KickThemOut
|
||||||
===========
|
============
|
||||||
|
|
||||||
`KickThemOut <https://nikolaskama.me/kickthemoutproject/>`_ - **Kick Devices Off Your Network**
|
`KickThemOut <https://nikolaskama.me/kickthemoutproject/>`_ - **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 <mailto:nikolaskam@gmail.com>`_ & `David Schütz <mailto:xdavid@protonmail.com>`_
|
||||||
|
|
||||||
|
.. image:: https://nikolaskama.me/...
|
||||||
|
|
||||||
|
Installation
|
||||||
|
-------------
|
||||||
|
|
||||||
|
You can download KickThemOut by cloning the `Git Repo <https://github.com/k4m4/kickthemout>`_ 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 <https://asciinema.org/~k4m4>`_)
|
||||||
|
|
||||||
|
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 <mailto:nikolaskam@gmail.com>`_ & `David Schütz <mailto:xdavid@protonmail.com>`_. All rights reserved.
|
||||||
|
|
||||||
|
KickThemOut is under the terms of the `MIT License <https://www.tldrlegal.com/l/mit>`_, following all clarifications stated in the `license file <https://raw.githubusercontent.com/k4m4/kickthemout/master/LICENSE>`_.
|
||||||
|
|
||||||
|
|
||||||
|
For more information head over to the `official project page <https://nikolaskama.me/kickthemoutproject/>`_.
|
||||||
|
You can also go ahead and email me anytime at **nikolaskam{at}gmail{dot}com** or David at **xdavid{at}protonmail{dot}com**.
|
1
requirements.txt
Normal file
1
requirements.txt
Normal file
@ -0,0 +1 @@
|
|||||||
|
scapy
|
Loading…
Reference in New Issue
Block a user