From c094f0400e9fd1c4a42254fd6c7f31c77298e8cd Mon Sep 17 00:00:00 2001 From: Stone_Red <56473591+Stone-Red-Code@users.noreply.github.com> Date: Tue, 29 Oct 2024 12:30:23 +0100 Subject: [PATCH] Update readme to new version and include banner --- README.md | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index f993190..f3ac18b 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,4 @@ -# ARP-Scanner - -> A lightweight cross-platform IP scanner +![Arp-Scanner](https://socialify.git.ci/Stone-Red-Code/Arp-Scanner/image?description=1&forks=1&issues=1&logo=data%3Aimage%2Fsvg%2Bxml%3Bbase64%2CPD94bWwgdmVyc2lvbj0iMS4wIiBzdGFuZGFsb25lPSJubyI%2FPgo8IURPQ1RZUEUgc3ZnIFBVQkxJQyAiLS8vVzNDLy9EVEQgU1ZHIDIwMDEwOTA0Ly9FTiIKICJodHRwOi8vd3d3LnczLm9yZy9UUi8yMDAxL1JFQy1TVkctMjAwMTA5MDQvRFREL3N2ZzEwLmR0ZCI%2BCjxzdmcgdmVyc2lvbj0iMS4wIiB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciCiB3aWR0aD0iMTAwLjAwMDAwMHB0IiBoZWlnaHQ9IjEwMC4wMDAwMDBwdCIgdmlld0JveD0iMCAwIDEwMC4wMDAwMDAgMTAwLjAwMDAwMCIKIHByZXNlcnZlQXNwZWN0UmF0aW89InhNaWRZTWlkIG1lZXQiPgo8bWV0YWRhdGE%2BCkNyZWF0ZWQgYnkgcG90cmFjZSAxLjEwLCB3cml0dGVuIGJ5IFBldGVyIFNlbGluZ2VyIDIwMDEtMjAxMQo8L21ldGFkYXRhPgogICA8cmVjdCB4PSIwIiB3aWR0aD0iMTAwIiBoZWlnaHQ9IjEwMCIgcng9IjE1IiBmaWxsPSIjNWE1YTVhIiAvPgo8ZyB0cmFuc2Zvcm09InRyYW5zbGF0ZSgwLjAwMDAwMCw5NS4wMDAwMDApIHNjYWxlKDAuMTAwMDAwLC0wLjEwMDAwMCkiCmZpbGw9IiMwMDAwMDAiIHN0cm9rZT0ibm9uZSI%2BCjxwYXRoIGQ9Ik02NDAgOTIwIGMtOSAtMTcgLTMgLTIzIDQ3IC00OSBsNTggLTMwIC0xMDIgLTEgLTEwMyAwIDAgLTMwIGMwIC0yNQotNCAtMzAgLTI0IC0zMCAtMTQgMCAtMjggLTQgLTMxIC0xMCAtNCAtNiAtNTYgLTEwIC0xMjIgLTEwIC0xNDggMCAtMTg1IC0xMQotMjQ4IC03NSAtNzMgLTcyIC04OSAtMTM1IC02MCAtMjMzIDIwIC02NiA2NiAtMTE5IDEzMCAtMTQ4IDQ4IC0yMyA1OCAtMjQKMzE2IC0yNCAyNTkgMCAyNjcgLTEgMzEwIC0yMyAyNCAtMTMgNTcgLTQzIDc0IC02NiAyNSAtMzYgMzAgLTU0IDMzIC0xMTcgNAotNjUgNyAtNzQgMjMgLTc0IDE2IDAgMTkgOCAxOSA1NiAwIDMxIC01IDc1IC0xMiA5OCAtMTYgNTUgLTk5IDEzOCAtMTU0IDE1NAotMjggOCAtMTI2IDEyIC0zMDEgMTIgLTI1MyAwIC0yNjEgMSAtMzA0IDIzIC0yNCAxMyAtNTcgNDMgLTc0IDY2IC0yNiAzNyAtMzAKNTEgLTMwIDExMSAwIDYwIDQgNzQgMzAgMTExIDE3IDIzIDUwIDUzIDc0IDY2IDM5IDIwIDU4IDIzIDE2NyAyMyA3MSAwIDEyNQotNCAxMjkgLTEwIDMgLTUgMTcgLTEwIDMwIC0xMCAxOCAwIDI0IC02IDI3IC0yNyBsMyAtMjggMTk4IC0zIDE5NyAtMiAwIDEwMAowIDEwMCAtNTkgMCBjLTUzIDAgLTY5IDUgLTE0NSA0OSAtODEgNDcgLTg2IDQ5IC05NiAzMXogbTIxMCAtMTA5IGMzOSAtNSA0NQotMTAgNTMgLTM4IDUgLTE3IDYgLTQ4IDMgLTY4IGwtNyAtMzYgLTE1NiAyIC0xNTYgMSAtMzIgMzQgLTMyIDM0IDMzIDM1IGMzMQozMyAzNyAzNSA5NiAzNSAzNSAwIDcwIDUgNzggMTAgOCA2IDI5IDggNDUgNCAxNyAtNCA1MCAtOSA3NSAtMTN6Ii8%2BCjxwYXRoIGQ9Ik0zMjAgNjE5IGMtNTYgLTI1IC0xNTAgLTk3IC0xNTAgLTExNSAwIC0xNyA5MiAtODcgMTUwIC0xMTMgNjAgLTI3CjE1MCAtMjcgMjEwIDAgNTUgMjUgMTUwIDk3IDE1MCAxMTQgMCAxNyAtOTUgODkgLTE1MCAxMTQgLTYwIDI3IC0xNTAgMjcgLTIxMAoweiBtMTkyIC0yOSBjMjggLTM0IDIzIC04NCAtMTEgLTEyMiAtNDMgLTQ4IC0xMDkgLTQ4IC0xNTIgMCAtNDQgNDkgLTM3IDEyMQoxNCAxNDIgMTIgNiA0NiA4IDc2IDYgNDIgLTIgNTkgLTggNzMgLTI2eiBtLTIxMCAtNDkgYy00IC00NSAtMiAtNTIgMzEgLTg3CjMzIC0zNiAzOSAtMzkgOTIgLTM5IDUzIDAgNTkgMyA5MiAzOSAzMyAzNSAzNSA0MiAzMSA4NyBsLTUgNDkgMjYgLTE2IGMxNCAtOQozOCAtMjggNTQgLTQyIGwyNyAtMjYgLTI3IC0yOCBjLTE1IC0xNiAtNTQgLTQyIC04NyAtNTggLTgwIC00MSAtMTQyIC00MQotMjIyIDAgLTU0IDI3IC0xMjQgODQgLTExMyA5MyAxMyAxMiAxMDEgNzcgMTAzIDc3IDIgMCAxIC0yMiAtMiAtNDl6Ii8%2BCjxwYXRoIGQ9Ik0zODQgNTY1IGMtMTkgLTI5IC0xMiAtNTcgMjAgLTc0IDI4IC0xNiA2MSAtMiA3MSAyOSA5IDMwIC0yMCA3MAotNTAgNzAgLTE1IDAgLTMxIC0xMCAtNDEgLTI1eiIvPgo8cGF0aCBkPSJNMjc2IDIyMiBjLTMgLTUgLTE4IC00NSAtMzUgLTkwIC0yMSAtNTcgLTI2IC04MiAtMTcgLTgyIDcgMCAxOCAxMQoyNCAyNCAxNSAzNCA2OSAzMyA4NSAtMSA5IC0yMCA0NCAtMzUgMzUgLTE1IC0xIDQgLTE2IDQ1IC0zMyA5MCAtMjcgNzQgLTQ1Cjk3IC01OSA3NHogbTI4IC01NiBjMyAtMTMgOCAtMzEgMTEgLTM4IDUgLTExIC0xIC0xNCAtMjMgLTEwIC0yOSA0IC0yOSA1IC0xOQozOCAxMiA0MCAyMiA0MyAzMSAxMHoiLz4KPHBhdGggZD0iTTM5OSAyMjggYy0xIC0yIC0zIC00MiAtNCAtOTAgLTIgLTY5IDAgLTg4IDExIC04OCAxMCAwIDE0IDEzIDE0IDQxCjAgMzMgMyA0MCAxOCAzNyA5IC0yIDI1IC0yMCAzNSAtNDAgMTAgLTIxIDI1IC0zOCAzNCAtMzggMTIgMCA5IDEwIC0xMSA0NQotMjEgMzggLTIzIDQ3IC0xMSA1MiAyMiA4IDE5IDYwIC00IDczIC0xNyA5IC03OSAxNSAtODIgOHogbTcxIC0zMyBjMTggLTIxIDUKLTQ1IC0yNSAtNDUgLTIxIDAgLTI1IDUgLTI1IDMwIDAgMjMgNSAzMCAxOSAzMCAxMCAwIDI0IC03IDMxIC0xNXoiLz4KPHBhdGggZD0iTTU1MCAxNDAgYzAgLTUzIDQgLTkwIDEwIC05MCA2IDAgMTAgMTYgMTAgMzUgMCAzMiAyIDM1IDI5IDM1IDMwIDAKNjEgMzAgNjEgNTcgMCAyNSAtMzkgNTMgLTc1IDUzIGwtMzUgMCAwIC05MHogbTY0IDU3IGMyNiAtMTkgMTcgLTUxIC0xNyAtNTUKLTI1IC0zIC0yNyAtMSAtMjcgMzIgMCAzOSAxMyA0NSA0NCAyM3oiLz4KPC9nPgo8L3N2Zz4K&name=1&pattern=Signal&pulls=1&stargazers=1&theme=Auto) ## Usage @@ -8,7 +6,12 @@ - Chocolatey (Windows): `choco install arp-scanner` - Snapcraft (Linux): `snap install arp-scanner` - GitHub (Windows/Linux): [releases](https://github.com/Stone-Red-Code/ARP-Scanner/releases) -1. Start `arp-scanner` with the IP range it should scan as parameter (e.g. `192.168.1.0 - 192.168.1.255`) +1. Use the command arp-scanner + - `arp-scanner help` lists all available commands + - `arp-scanner scan` scans the network for devices + - `arp-scanner scan --help` lists all available options for the scan command + - `arp-scanner monitor` continuously scans the network for devices + - `arp-scanner monitor --help` lists all available options for the monitor command > [!Note] > This programm may not work on all linux distributions because the [ArpLookup](https://github.com/georg-jung/ArpLookup) library has some [limitations](https://github.com/georg-jung/ArpLookup#supported-platforms) @@ -17,6 +20,8 @@ [![Twitter(X)](http://img.shields.io/badge/Twitter-black.svg?&logo=x&style=for-the-badge&logoColor=white)](https://twitter.com/search?q=%23ArpScanner%20%40StoneRedCode&f=live) ## Example + +Start `arp-scanner` with the IP range it should scan as parameter (e.g. `192.168.1.0-192.168.1.255`) ![ARP-Scanner-Example](https://user-images.githubusercontent.com/56473591/236293969-4e8a65d2-86a3-4f10-8837-2b1aa0490252.png)