From eb470af8ea441c5381ea8ff4d971005008008b02 Mon Sep 17 00:00:00 2001 From: Aram Drevekenin Date: Thu, 17 Oct 2019 22:00:51 +0200 Subject: docs(readme): add demo and more details --- README.md | 24 ++++++++++++++++++------ 1 file changed, 18 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index c5e0168..ae20d5b 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,23 @@ -### what -Display current network utilization by process and connection. +## what +...is taking up my bandwidth?! -This is my first attempt at Rust and is still very much a WIP. :) +![demo](demo.gif) + +(display current network utilization by process, connection and remote IP/hostname) + +This is my first attempt at Rust. :) ### How does it work? -`what` sniffs a given network interface (provided as the second cli argument, eg. `what eth0`) and records packet size, cross referencing it with the `/proc` filesystem. +`what` sniffs a given network interface and records IP packet size, cross referencing it with the `/proc` filesystem. + +`what` is responsive to the terminal window size, displaying less info if there is no room for it. + +`what` will attempt to resolve ips to their host name in the background using reverse DNS on a best effort basis. + +### Installation +At the moment, `what` is available through Cargo as a binary package. -Currently, it relies on the display loop to reset its state every second and thus always display the bandwidth per second. +### Usage +`what -i ` eg. `what -i eth0` -At the moment there is only a linux implementation but the tests should (hopefully!) run on all platforms. +Note that since `what` sniffs network packets, it requires root privileges - so you might want to use it with (for example) `sudo`. -- cgit v1.2.3 From 79d54be823e55fe7d27e289ca1894595f0fbb3d9 Mon Sep 17 00:00:00 2001 From: Aram Drevekenin Date: Thu, 17 Oct 2019 22:02:21 +0200 Subject: docs(readme): better wording --- README.md | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/README.md b/README.md index ae20d5b..d1ff4e4 100644 --- a/README.md +++ b/README.md @@ -8,11 +8,7 @@ This is my first attempt at Rust. :) ### How does it work? -`what` sniffs a given network interface and records IP packet size, cross referencing it with the `/proc` filesystem. - -`what` is responsive to the terminal window size, displaying less info if there is no room for it. - -`what` will attempt to resolve ips to their host name in the background using reverse DNS on a best effort basis. +`what` sniffs a given network interface and records IP packet size, cross referencing it with the `/proc` filesystem. 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 At the moment, `what` is available through Cargo as a binary package. -- cgit v1.2.3