Skip to content

Commit fad4610

Browse files
committed
docs: add CI badge and README touch-ups
1 parent 103c6b3 commit fad4610

1 file changed

Lines changed: 22 additions & 2 deletions

File tree

README.md

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
A Python-based subnet scanner to discover live hosts, retrieve MAC addresses, identify NIC vendors, and scan for open ports with service detection.
44

5+
[![CI](https://github.com/256kMagic/NetTools/actions/workflows/ci.yml/badge.svg)](https://github.com/256kMagic/NetTools/actions/workflows/ci.yml)
6+
57
## Overview
68

79
`nettool-v8.py` is a command-line tool designed for network reconnaissance on Windows. It performs:
@@ -35,5 +37,23 @@ The tool uses a synchronous approach for vendor lookups to ensure reliability, a
3537
## Installation
3638
1. Clone the repository:
3739
```bash
38-
git clone https://github.com/256kmagic/NetTools-v1.git
39-
cd NetTools-v1
40+
git clone https://github.com/256kMagic/NetTools.git
41+
cd NetTools
42+
```
43+
2. Install dependencies:
44+
```bash
45+
pip install colorama tqdm python-nmap
46+
```
47+
3. Install Nmap and ensure it is on your PATH.
48+
49+
## Usage
50+
```bash
51+
python nettool-v8.py 192.168.1.0/24
52+
```
53+
54+
## Notes
55+
- Requires Windows with admin rights for ARP and Nmap.
56+
- Ensure `mac_vendors.txt` is present in the repo root for vendor mapping.
57+
58+
## License
59+
MIT License. See [LICENSE](LICENSE).

0 commit comments

Comments
 (0)