summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorBSKY <git@bsky.moe>2020-01-06 04:40:41 +0900
committerAram Drevekenin <aram@poor.dev>2020-01-05 20:40:41 +0100
commitba82d37ecd6cf3c12b38d8c3f3a5183b79e1a735 (patch)
treefa9de39e38a50d6ea134a5230ada269029d7fd17 /README.md
parent6190391601d6f7de004b3ec85685e94e816750da (diff)
chore(packaging): add installation instruction with brew (#75)
* Update README.md * docs(comment): warning not to break homebrew test Co-authored-by: Aram Drevekenin <aram@poor.dev>
Diffstat (limited to 'README.md')
-rw-r--r--README.md10
1 files changed, 8 insertions, 2 deletions
diff --git a/README.md b/README.md
index 771d586..4d30240 100644
--- a/README.md
+++ b/README.md
@@ -5,7 +5,7 @@
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 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.
### Installation
@@ -23,7 +23,13 @@ yay -S bandwhich
nix-env -iA nixpkgs.bandwhich
```
-#### MacOS and other Linux flavours
+#### macOS
+
+```
+brew install bandwhich
+```
+
+#### Other Linux flavours
`bandwhich` can be installed using the Rust package manager, cargo. If it's not in your distro repositories or the available version is too old, 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).