summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorAram Drevekenin <aram@poor.dev>2020-09-20 13:57:45 +0200
committerGitHub <noreply@github.com>2020-09-20 13:57:45 +0200
commit8020b9491470d60d4263035215f5d18941c45020 (patch)
tree0f33fbcdba58c513769c64913634ea259a2f10a2 /README.md
parente64b15a20bb74d8090be9055ee81395046d0bd96 (diff)
docs(readme): update for windows and re-order installation instructions
Diffstat (limited to 'README.md')
-rw-r--r--README.md8
1 files changed, 4 insertions, 4 deletions
diff --git a/README.md b/README.md
index 9130633..a313973 100644
--- a/README.md
+++ b/README.md
@@ -5,10 +5,13 @@
This is a CLI utility for displaying current network utilization by process, connection and remote IP/hostname
### How does it work?
-`bandwhich` sniffs a given network interface and records IP packet size, cross referencing it with the `/proc` filesystem on linux or `lsof` on macOS. It is responsive to the terminal window size, displaying less info if there is no room for it. It will also attempt to resolve ips to their host name in the background using reverse DNS on a best effort basis.
+`bandwhich` sniffs a given network interface and records IP packet size, cross referencing it with the `/proc` filesystem on linux, `lsof` on macOS, or using WinApi on windows. It is responsive to the terminal window size, displaying less info if there is no room for it. It will also attempt to resolve ips to their host name in the background using reverse DNS on a best effort basis.
### Installation
+#### Download a prebuilt binary
+If you're on linux, you can download the generic binary from the releases.
+
#### Arch Linux
```
@@ -55,9 +58,6 @@ or
cd /usr/ports/net-mgmt/bandwhich && make install clean
```
-#### Download a prebuilt binary
-If you're on linux, you could also get the generic binary from the releases.
-
#### Windows / Other Linux flavours
`bandwhich` can be installed using the Rust package manager, cargo. It might be in your distro repositories if you're on linux, or you can install it via [rustup](https://rustup.rs/). You can find additional installation instructions [here](https://doc.rust-lang.org/book/ch01-01-installation.html).