33[ ![ Build Status] ( https://github.com/NickBorgers/util/workflows/Build%20and%20Test/badge.svg )] ( https://github.com/NickBorgers/util/actions )
44[ ![ Release] ( https://github.com/NickBorgers/util/workflows/Release/badge.svg )] ( https://github.com/NickBorgers/util/releases )
55[ ![ Docker] ( https://img.shields.io/badge/docker-available-blue )] ( https://github.com/NickBorgers/util/pkgs/container/network-mapper )
6+ [ ![ Homebrew] ( https://img.shields.io/badge/homebrew-available-orange )] ( https://github.com/NickBorgers/homebrew-tap )
7+ [ ![ Chocolatey] ( https://img.shields.io/badge/chocolatey-available-brown )] ( https://chocolatey.org/packages/network-mapper )
68[ ![ Go Report Card] ( https://goreportcard.com/badge/github.com/NickBorgers/util )] ( https://goreportcard.com/report/github.com/NickBorgers/util )
79[ ![ License: MIT] ( https://img.shields.io/badge/License-MIT-yellow.svg )] ( https://opensource.org/licenses/MIT )
810
11+ ** Quick Install:** ` brew install nickborgers/tap/network-mapper ` | ` choco install network-mapper ` | ` docker run --rm --network host ghcr.io/nickborgers/network-mapper:latest `
12+
913A cross-platform CLI tool that scans your local network, discovers devices, and presents a beautiful pictographic representation of the network topology.
1014
1115## Features
@@ -44,25 +48,40 @@ A cross-platform CLI tool that scans your local network, discovers devices, and
4448
4549## Installation
4650
47- ### Download Pre-built Binaries
51+ Choose your preferred installation method:
4852
49- Download the latest release for your platform from the [ GitHub Releases ] ( https://github.com/NickBorgers/util/releases ) page:
53+ ### 🍺 Homebrew (macOS/Linux)
5054
51- - ** Linux (x64)** : ` network-mapper-linux-amd64 `
52- - ** Linux (ARM64)** : ` network-mapper-linux-arm64 `
53- - ** macOS (Intel)** : ` network-mapper-darwin-amd64 `
54- - ** macOS (Apple Silicon)** : ` network-mapper-darwin-arm64 `
55- - ** Windows (x64)** : ` network-mapper-windows-amd64.exe `
55+ The easiest way to install on macOS and Linux:
5656
57- Make the binary executable and run:
5857``` bash
59- chmod +x network-mapper-*
60- ./network-mapper-* --help
58+ # Add the tap and install
59+ brew tap nickborgers/tap
60+ brew install network-mapper
61+
62+ # Or install directly
63+ brew install nickborgers/tap/network-mapper
64+
65+ # Upgrade to latest version
66+ brew upgrade network-mapper
67+ ```
68+
69+ ### 🍫 Chocolatey (Windows)
70+
71+ For Windows users with Chocolatey:
72+
73+ ``` powershell
74+ # Install
75+ choco install network-mapper
76+
77+ # Upgrade to latest version
78+ choco upgrade network-mapper
6179```
6280
63- ### Docker
81+ ### 🐳 Docker
82+
83+ Run directly with Docker (cross-platform):
6484
65- Run directly with Docker:
6685``` bash
6786# Pull from GitHub Container Registry
6887docker pull ghcr.io/nickborgers/network-mapper:latest
@@ -71,7 +90,23 @@ docker pull ghcr.io/nickborgers/network-mapper:latest
7190docker run --rm --network host ghcr.io/nickborgers/network-mapper:latest
7291
7392# Quick scan without service discovery
74- docker run --rm --network host ghcr.io/nickborgers/network-mapper:latest --no-services
93+ docker run --rm --network host ghcr.io/nickborgers/network-mapper:latest --scan-mode quick
94+ ```
95+
96+ ### 📦 Pre-built Binaries
97+
98+ Download the latest release for your platform from the [ GitHub Releases] ( https://github.com/NickBorgers/util/releases ) page:
99+
100+ - ** Linux (x64)** : ` network-mapper-linux-amd64 `
101+ - ** Linux (ARM64)** : ` network-mapper-linux-arm64 `
102+ - ** macOS (Intel)** : ` network-mapper-darwin-amd64 `
103+ - ** macOS (Apple Silicon)** : ` network-mapper-darwin-arm64 `
104+ - ** Windows (x64)** : ` network-mapper-windows-amd64.exe `
105+
106+ Make the binary executable and run:
107+ ``` bash
108+ chmod +x network-mapper-*
109+ ./network-mapper-* --help
75110```
76111
77112### Build from Source
@@ -111,25 +146,7 @@ go build -o network-mapper
111146
112147### Package Managers
113148
114- #### Homebrew (macOS/Linux)
115-
116- ``` bash
117- # Coming soon
118- brew install nickborgers/tap/network-mapper
119- ```
120-
121- #### Chocolatey (Windows)
122-
123- ``` bash
124- # Coming soon
125- choco install network-mapper
126- ```
127-
128- #### APT/YUM Packages
129-
130- ``` bash
131- # Coming soon - .deb and .rpm packages
132- ```
149+ See [ Installation] ( #installation ) section above for complete package manager setup.
133150
134151## Usage
135152
0 commit comments